# Models ## The EnterCampaignStep object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"EnterCampaignStep":{"type":"object","required":["Step","Success","Reason"],"properties":{"Step":{"type":"string"},"Success":{"type":"integer"},"Reason":{"type":"string"},"Comment":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionRenewalPriceRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionRenewalPriceRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to renew","items":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"}}},"PartnerSubscriptionRenewalItem":{"type":"object","required":["SubscriptionReference"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"Quantity":{"type":"integer","description":"Quantity for renewal"},"PricingOptions":{"type":"array","description":"Pricing options for the subscription","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}}}}} ``` ## The PartnerSubscriptionRenewalOrderRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionRenewalOrderRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to renew","items":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExternalReferenceNumber":{"type":"string","description":"External reference number for tracking"},"Comment":{"type":"string","description":"Comment to attach to the order"}}},"PartnerSubscriptionRenewalItem":{"type":"object","required":["SubscriptionReference"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"Quantity":{"type":"integer","description":"Quantity for renewal"},"PricingOptions":{"type":"array","description":"Pricing options for the subscription","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}}}}} ``` ## The PartnerSubscriptionUpgradePriceRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionUpgradePriceRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to upgrade","items":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradeItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"}}},"PartnerSubscriptionUpgradeItem":{"type":"object","required":["SubscriptionReference","ProductCode"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"ProductCode":{"type":"string","description":"Product code to upgrade to"},"Quantity":{"type":"integer","description":"Quantity for upgrade"},"PricingOptions":{"type":"array","description":"Pricing options for the upgraded product","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}}}}} ``` ## The PartnerSubscriptionUpgradeOrderRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionUpgradeOrderRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to upgrade","items":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradeItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExternalReferenceNumber":{"type":"string","description":"External reference number for tracking"},"Comment":{"type":"string","description":"Comment to attach to the order"}}},"PartnerSubscriptionUpgradeItem":{"type":"object","required":["SubscriptionReference","ProductCode"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"ProductCode":{"type":"string","description":"Product code to upgrade to"},"Quantity":{"type":"integer","description":"Quantity for upgrade"},"PricingOptions":{"type":"array","description":"Pricing options for the upgraded product","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}}}}} ``` ## The PartnerSubscriptionRenewalItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionRenewalItem":{"type":"object","required":["SubscriptionReference"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"Quantity":{"type":"integer","description":"Quantity for renewal"},"PricingOptions":{"type":"array","description":"Pricing options for the subscription","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}}}}} ``` ## The PartnerSubscriptionUpgradeItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionUpgradeItem":{"type":"object","required":["SubscriptionReference","ProductCode"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"ProductCode":{"type":"string","description":"Product code to upgrade to"},"Quantity":{"type":"integer","description":"Quantity for upgrade"},"PricingOptions":{"type":"array","description":"Pricing options for the upgraded product","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}}}}} ``` ## The ExtraDiscountMargin object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}}}}} ``` ## The PricingOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}}}}} ``` ## The PartnerSubscriptionPriceResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionPriceResponse":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency code"},"NetPrice":{"type":"number","format":"float","description":"Net price (excluding tax)"},"GrossPrice":{"type":"number","format":"float","description":"Gross price (including tax)"},"Vat":{"type":"number","format":"float","description":"VAT/tax amount"},"TotalDiscount":{"type":"number","format":"float","description":"Total discount amount"},"Discount":{"type":"number","format":"float","description":"Base discount amount"},"PartnerMargin":{"type":"number","format":"float","description":"Partner margin amount"},"ExtraMargin":{"type":"number","format":"float","description":"Extra margin applied"},"ExtraDiscount":{"type":"number","format":"float","description":"Extra discount applied"},"Items":{"type":"array","description":"Detailed pricing for each cart item","items":{"$ref":"#/components/schemas/PartnerSubscriptionCartItem"}}}},"PartnerSubscriptionCartItem":{"type":"object","properties":{"PurchaseType":{"type":"string","description":"Type of purchase (RENEWAL or UPGRADE)"},"PricingListCode":{"type":"string","description":"Pricing configuration code"},"SubscriptionReference":{"type":"string","description":"Subscription reference"},"Quantity":{"type":"integer","description":"Quantity"},"Prices":{"$ref":"#/components/schemas/PartnerSubscriptionCartItemPrices"},"Product":{"$ref":"#/components/schemas/PartnerSubscriptionCartProduct"},"ProductOptions":{"type":"array","description":"Product options selected","items":{"$ref":"#/components/schemas/PartnerSubscriptionProductOption"}},"Promotion":{"$ref":"#/components/schemas/PartnerSubscriptionCartPromotion"}}},"PartnerSubscriptionCartItemPrices":{"type":"object","description":"Detailed pricing breakdown for cart item","properties":{"NetPrice":{"type":"number","format":"float"},"GrossPrice":{"type":"number","format":"float"},"TotalDiscount":{"type":"number","format":"float"},"PartnerMargin":{"type":"number","format":"float"},"ExtraMargin":{"type":"number","format":"float"},"ExtraDiscount":{"type":"number","format":"float"},"Discount":{"type":"number","format":"float"},"CouponDiscount":{"type":"number","format":"float"},"Vat":{"type":"number","format":"float"},"UnitNetPrice":{"type":"number","format":"float"},"UnitGrossPrice":{"type":"number","format":"float"},"UnitTotalDiscount":{"type":"number","format":"float"},"UnitPartnerMargin":{"type":"number","format":"float"},"UnitExtraMargin":{"type":"number","format":"float"},"UnitExtraDiscount":{"type":"number","format":"float"},"UnitDiscount":{"type":"number","format":"float"},"UnitCouponDiscount":{"type":"number","format":"float"},"UnitVat":{"type":"number","format":"float"},"VatPercent":{"type":"number","format":"float"},"PartnerMarginPercent":{"type":"number","format":"float"}}},"PartnerSubscriptionCartProduct":{"type":"object","description":"Product information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Version":{"type":"string"},"ShortDescription":{"type":"string"}}},"PartnerSubscriptionProductOption":{"type":"object","description":"Selected product option","properties":{"Code":{"type":"string"}}},"PartnerSubscriptionCartPromotion":{"type":"object","description":"Applied promotion information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Coupon":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionCartItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionCartItem":{"type":"object","properties":{"PurchaseType":{"type":"string","description":"Type of purchase (RENEWAL or UPGRADE)"},"PricingListCode":{"type":"string","description":"Pricing configuration code"},"SubscriptionReference":{"type":"string","description":"Subscription reference"},"Quantity":{"type":"integer","description":"Quantity"},"Prices":{"$ref":"#/components/schemas/PartnerSubscriptionCartItemPrices"},"Product":{"$ref":"#/components/schemas/PartnerSubscriptionCartProduct"},"ProductOptions":{"type":"array","description":"Product options selected","items":{"$ref":"#/components/schemas/PartnerSubscriptionProductOption"}},"Promotion":{"$ref":"#/components/schemas/PartnerSubscriptionCartPromotion"}}},"PartnerSubscriptionCartItemPrices":{"type":"object","description":"Detailed pricing breakdown for cart item","properties":{"NetPrice":{"type":"number","format":"float"},"GrossPrice":{"type":"number","format":"float"},"TotalDiscount":{"type":"number","format":"float"},"PartnerMargin":{"type":"number","format":"float"},"ExtraMargin":{"type":"number","format":"float"},"ExtraDiscount":{"type":"number","format":"float"},"Discount":{"type":"number","format":"float"},"CouponDiscount":{"type":"number","format":"float"},"Vat":{"type":"number","format":"float"},"UnitNetPrice":{"type":"number","format":"float"},"UnitGrossPrice":{"type":"number","format":"float"},"UnitTotalDiscount":{"type":"number","format":"float"},"UnitPartnerMargin":{"type":"number","format":"float"},"UnitExtraMargin":{"type":"number","format":"float"},"UnitExtraDiscount":{"type":"number","format":"float"},"UnitDiscount":{"type":"number","format":"float"},"UnitCouponDiscount":{"type":"number","format":"float"},"UnitVat":{"type":"number","format":"float"},"VatPercent":{"type":"number","format":"float"},"PartnerMarginPercent":{"type":"number","format":"float"}}},"PartnerSubscriptionCartProduct":{"type":"object","description":"Product information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Version":{"type":"string"},"ShortDescription":{"type":"string"}}},"PartnerSubscriptionProductOption":{"type":"object","description":"Selected product option","properties":{"Code":{"type":"string"}}},"PartnerSubscriptionCartPromotion":{"type":"object","description":"Applied promotion information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Coupon":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionCartItemPrices object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionCartItemPrices":{"type":"object","description":"Detailed pricing breakdown for cart item","properties":{"NetPrice":{"type":"number","format":"float"},"GrossPrice":{"type":"number","format":"float"},"TotalDiscount":{"type":"number","format":"float"},"PartnerMargin":{"type":"number","format":"float"},"ExtraMargin":{"type":"number","format":"float"},"ExtraDiscount":{"type":"number","format":"float"},"Discount":{"type":"number","format":"float"},"CouponDiscount":{"type":"number","format":"float"},"Vat":{"type":"number","format":"float"},"UnitNetPrice":{"type":"number","format":"float"},"UnitGrossPrice":{"type":"number","format":"float"},"UnitTotalDiscount":{"type":"number","format":"float"},"UnitPartnerMargin":{"type":"number","format":"float"},"UnitExtraMargin":{"type":"number","format":"float"},"UnitExtraDiscount":{"type":"number","format":"float"},"UnitDiscount":{"type":"number","format":"float"},"UnitCouponDiscount":{"type":"number","format":"float"},"UnitVat":{"type":"number","format":"float"},"VatPercent":{"type":"number","format":"float"},"PartnerMarginPercent":{"type":"number","format":"float"}}}}}} ``` ## The PartnerSubscriptionCartProduct object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionCartProduct":{"type":"object","description":"Product information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Version":{"type":"string"},"ShortDescription":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionProductOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionProductOption":{"type":"object","description":"Selected product option","properties":{"Code":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionCartPromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionCartPromotion":{"type":"object","description":"Applied promotion information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Coupon":{"type":"string"}}}}}} ``` ## The PartnerSubscriptionOrderResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerSubscriptionOrderResponse":{"type":"object","description":"Order placement response","properties":{"RefNo":{"type":"integer","description":"Order reference number"},"Status":{"type":"string","description":"Order status"},"TotalAmount":{"type":"number","format":"float","description":"Total order amount"},"Currency":{"type":"string","description":"Currency code"}}}}}} ``` ## The ChurnReasonRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ChurnReasonRequest":{"type":"object","properties":{"ChurnReasons":{"type":"array","items":{"type":"string"}},"ChurnReasonOther":{"type":"string"}}}}}} ``` ## The SSOCreateResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SSOCreateResponse":{"type":"object","properties":{"url":{"type":"string","description":"requested url with appended token"},"expiresIn":{"type":"integer","description":"Expiration time in seconds"}}}}}} ``` ## The SearchUpsellResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchUpsellResponse":{"title":"SearchUpsellResponse","type":"object","properties":{"Page":{"type":"integer","description":"Current page number"},"Limit":{"type":"integer","description":"Number of upsell campaigns in a page"},"Upsells":{"type":"array","description":"Upsell collection from the current page","items":{"$ref":"#/components/schemas/UpsellResponse"}},"UpsellsCount":{"type":"integer","description":"Total number of filtered upsell campaigns"},"PagesCount":{"type":"integer","description":"Total number of pages"}}},"UpsellResponse":{"type":"object","properties":{"Code":{"type":"string","description":"Uniquely generated campaign code"},"Name":{"type":"string","description":"Name of campaign"},"StartDate":{"type":"string","description":"When will campaign start","nullable":true},"EndDate":{"type":"string","description":"When will campaign end","nullable":true},"DisplayForManualRenewals":{"type":"boolean","description":"Flag that controls compaign display for manual renewals"},"Discount":{"oneOf":[{"$ref":"#/components/schemas/UpsellCampaignDiscountFixed"},{"$ref":"#/components/schemas/UpsellCampaignDiscountPercent"}]},"PrimaryProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"RecommendedProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"Enabled":{"type":"boolean","description":"Flag that controls if the compaign is enabled"},"Description":{"type":"array","description":"The list of campaign language descriptions","items":{"$ref":"#/components/schemas/UpsellCampaignLanguageDescription"}}}},"UpsellCampaignDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"discount default currency"}}},"UpsellCampaignDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"integer","description":"price discount amount"}}},"UpsellCampaignDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}},"UpsellCampaignProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Product quantity (0 means any quantity)"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOption"}}}},"UpsellCampaignProductPriceOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option code"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOptionOption"}}}},"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}},"UpsellCampaignLanguageDescription":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Text":{"type":"string","description":"campaign text in the specified language code"}}}}}} ``` ## The UpdateLicensePaymentInformationPayload object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateLicensePaymentInformationPayload":{"type":"object","properties":{"PaymentDetails":{"$ref":"#/components/schemas/UpdateLicensePaymentInformationPaymentDetails"}}},"UpdateLicensePaymentInformationPaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/UpdateLicensePaymentInformationPaymentMethod"}}},"UpdateLicensePaymentInformationPaymentMethod":{"type":"object","properties":{"EesToken":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"}}}}}} ``` ## The UpdateLicensePaymentInformationPaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateLicensePaymentInformationPaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/UpdateLicensePaymentInformationPaymentMethod"}}},"UpdateLicensePaymentInformationPaymentMethod":{"type":"object","properties":{"EesToken":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"}}}}}} ``` ## The UpdateLicensePaymentInformationPaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateLicensePaymentInformationPaymentMethod":{"type":"object","properties":{"EesToken":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"}}}}}} ``` ## The GetAvailableCurrenciesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetAvailableCurrenciesResponse":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string"},"ISO3DigitCode":{"type":"integer"},"Label":{"type":"string"},"Symbol":{"type":"string"},"SymbolPosition":{"type":"string"},"DecimalSeparator":{"type":"string"},"UnitSeparator":{"type":"string"},"Decimals":{"type":"integer"}}}}}}} ``` ## The GetAvailableCountriesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetAvailableCountriesResponse":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string"},"Label":{"type":"string"}}}}}}} ``` ## The GetAvailablePaymentMethodsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetAvailablePaymentMethodsResponse":{"type":"array","items":{"type":"object","properties":{"Currencies":{"type":"array","items":{"type":"string","description":"ISO 3-Letter Currency Code"}},"Countries":{"type":"array","items":{"type":"string","description":"ISO 2-Letter Country Code"}},"BusinessCompany":{"type":"string"},"HasRenewal":{"type":"boolean"},"PaymentType":{"type":"string"},"PaymentMethod":{"type":"string"},"AutofillSettings":{"$ref":"#/components/schemas/GetAvailablePaymentMethodsResponse_AutofillSettings"},"SupportsTrial":{"type":"boolean"}}}},"GetAvailablePaymentMethodsResponse_AutofillSettings":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}}} ``` ## The GetAvailablePaymentMethodsResponse\_AutofillSettings object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetAvailablePaymentMethodsResponse_AutofillSettings":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}}} ``` ## The GetCountryStatesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetCountryStatesResponse":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"}}}}}}} ``` ## The UnlinkCustomerCreditCardResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UnlinkCustomerCreditCardResponse":{"type":"object","properties":{"Deleted":{"type":"boolean"}}}}}} ``` ## The UnlinkCustomerCreditCard400Response object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UnlinkCustomerCreditCard400Response":{"type":"object","properties":{"Deleted":{"type":"boolean"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/UnlinkCustomerCreditCard400ErrorResponse"}}}},"UnlinkCustomerCreditCard400ErrorResponse":{"type":"object","properties":{"SubscriptionReference":{"type":"string"},"Message":{"type":"string"},"ErrorCode":{"type":"string"}}}}}} ``` ## The UnlinkCustomerCreditCard400ErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UnlinkCustomerCreditCard400ErrorResponse":{"type":"object","properties":{"SubscriptionReference":{"type":"string"},"Message":{"type":"string"},"ErrorCode":{"type":"string"}}}}}} ``` ## The LanguageLineItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LanguageLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/LanguageLineItem"}},"LanguageLineItem":{"title":"LineItem","type":"object","properties":{"Code":{"type":"string","description":"ISO2 language code"},"Name":{"type":"string","description":"Language name"}}}}}} ``` ## The LanguageLineItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LanguageLineItem":{"title":"LineItem","type":"object","properties":{"Code":{"type":"string","description":"ISO2 language code"},"Name":{"type":"string","description":"Language name"}}}}}} ``` ## The InvoiceTemplates object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"InvoiceTemplates":{"title":"InvoiceTemplates","type":"array","description":"Invoice templates colection","items":{"$ref":"#/components/schemas/InvoiceTemplate"}},"InvoiceTemplate":{"title":"InvoiceTemplate","type":"object","properties":{"IdInvoiceTemplate":{"type":"string","description":"Invoice template id"},"TemplateName":{"type":"string","description":"Template name"}}}}}} ``` ## The InvoiceTemplate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"InvoiceTemplate":{"title":"InvoiceTemplate","type":"object","properties":{"IdInvoiceTemplate":{"type":"string","description":"Invoice template id"},"TemplateName":{"type":"string","description":"Template name"}}}}}} ``` ## The SSOCreateRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SSOCreateRequest":{"title":"SSO Create Request","type":"object","description":"SSO create request","properties":{"Email":{"type":"string","description":"The partner email address"},"AccessPage":{"type":"string","description":"Access page"},"ValidityTime":{"type":"integer","description":"Token Validity Time"},"ValidationIp":{"type":"string","description":"Validation Ip"}},"required":["Email","AccessPage"]}}}} ``` ## The ProformaRefundRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProformaRefundRequest":{"title":"Proforma Refund Request","type":"object","description":"Proforma Refund Request","properties":{"ProformaNumber":{"type":"integer","description":"The partner's proforma number"},"Comment":{"type":"string","description":"Request comment"}},"required":["ProformaNumber","Comment"]}}}} ``` ## The GetPrice object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPrice":{"required":["Currency","Item"],"type":"object","properties":{"Item":{"$ref":"#/components/schemas/GetPrice_Item"},"BillingDetails":{"$ref":"#/components/schemas/GetPrice_BillingDetails"},"Currency":{"type":"string"},"CouponCode":{"type":"string"},"PayType":{"type":"string","enum":["CC","ENCRYPTED_PAYMENT_DATA","PAYPAL","PAYPAL_EXPRESS","TEST","PREVIOUS_ORDER","EXISTING_PAYMENT_DATA","WIRE","CHECK","PURCHASEORDER","FREE"]}}},"GetPrice_Item":{"required":["Code","Quantity"],"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"PriceOptions":{"type":"array","items":{}}}},"GetPrice_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Zip":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"}}}}}} ``` ## The GetPriceResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPriceResponse":{"type":"object","properties":{"ItemPrice":{"type":"object"},"UnitNetPrice":{"type":"number"},"UnitGrossPrice":{"type":"number"},"UnitVAT":{"type":"integer"},"UnitDiscount":{"type":"integer"},"UnitNetDiscountedPrice":{"type":"number"},"UnitGrossDiscountedPrice":{"type":"number"},"UnitAffiliateCommission":{"type":"integer"},"VATPercent":{"type":"integer"},"HandlingFeeNetPrice":{"type":"integer"},"HandlingFeeGrossPrice":{"type":"integer"},"AffiliateCommission":{"type":"number"},"Currency":{"type":"string"},"Discount":{"type":"number"},"GrossDiscountedPrice":{"type":"number"},"GrossPrice":{"type":"number"},"NetDiscountedPrice":{"type":"number"},"NetPrice":{"type":"number"},"VAT":{"type":"number"}}}}}} ``` ## The GetPriceError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPriceError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The CrossSellCreate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellCreate":{"required":["DisplayInEmail","DisplayType","MasterProducts","Name","Products"],"type":"object","properties":{"Name":{"type":"string","description":"Name of campaign, max 255 chars."},"MasterProducts":{"type":"array","items":{"type":"string","description":"array of product code ids to which this cross sell is going to be applied to"}},"DisplayType":{"type":"string","description":"Where should cross sell products be displayed","enum":["cart","review","finish"]},"DisplayInEmail":{"type":"boolean","description":"true/false - display in payment receipt emails or not"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Response"}},"StartDate":{"type":"string","description":"When should campaign start","nullable":true},"EndDate":{"type":"string","description":"When should campaign end","nullable":true}}},"CrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","format":"float","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"Errors":{"type":"array","items":{"type":"string"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellUpdate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellUpdate":{"allOf":[{"type":"object","required":["CampaignCode","CampaignStatus"],"properties":{"CampaignCode":{"type":"string","description":"The unique code of the cross-sell campaign"},"CampaignStatus":{"type":"string","description":"The cross-selll campaign status","enum":["ACTIVE","DISABLED"]}}},{"$ref":"#/components/schemas/CrossSellCreate"}]},"CrossSellCreate":{"required":["DisplayInEmail","DisplayType","MasterProducts","Name","Products"],"type":"object","properties":{"Name":{"type":"string","description":"Name of campaign, max 255 chars."},"MasterProducts":{"type":"array","items":{"type":"string","description":"array of product code ids to which this cross sell is going to be applied to"}},"DisplayType":{"type":"string","description":"Where should cross sell products be displayed","enum":["cart","review","finish"]},"DisplayInEmail":{"type":"boolean","description":"true/false - display in payment receipt emails or not"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Response"}},"StartDate":{"type":"string","description":"When should campaign start","nullable":true},"EndDate":{"type":"string","description":"When should campaign end","nullable":true}}},"CrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","format":"float","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"Errors":{"type":"array","items":{"type":"string"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellUpdateResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellUpdateResponse":{"allOf":[{"$ref":"#/components/schemas/CrossSellUpdate"},{"type":"object","properties":{"Errors":{"type":"array","items":{"type":"string"}}}}]},"CrossSellUpdate":{"allOf":[{"type":"object","required":["CampaignCode","CampaignStatus"],"properties":{"CampaignCode":{"type":"string","description":"The unique code of the cross-sell campaign"},"CampaignStatus":{"type":"string","description":"The cross-selll campaign status","enum":["ACTIVE","DISABLED"]}}},{"$ref":"#/components/schemas/CrossSellCreate"}]},"CrossSellCreate":{"required":["DisplayInEmail","DisplayType","MasterProducts","Name","Products"],"type":"object","properties":{"Name":{"type":"string","description":"Name of campaign, max 255 chars."},"MasterProducts":{"type":"array","items":{"type":"string","description":"array of product code ids to which this cross sell is going to be applied to"}},"DisplayType":{"type":"string","description":"Where should cross sell products be displayed","enum":["cart","review","finish"]},"DisplayInEmail":{"type":"boolean","description":"true/false - display in payment receipt emails or not"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Response"}},"StartDate":{"type":"string","description":"When should campaign start","nullable":true},"EndDate":{"type":"string","description":"When should campaign end","nullable":true}}},"CrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","format":"float","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"Errors":{"type":"array","items":{"type":"string"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The UpsellUpdateSettings object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellUpdateSettings":{"required":["UpsellingDisplayType"],"type":"object","properties":{"UpsellingDisplayType":{"type":"string","description":"Update displayType setting"}}}}}} ``` ## The CrossSellProduct\_Request object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellProduct_Request":{"required":["Discount","DiscountType","ProductCode"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"integer","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]}},"title":"CrossSell request product"}}}} ``` ## The CrossSellProductDiscountedPrice object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellProductBasePrice object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellProduct\_Response object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","format":"float","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"Errors":{"type":"array","items":{"type":"string"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The GetCrossSellProduct\_Response object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetCrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice","BasePrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"BasePrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductBasePrice"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellResponse":{"type":"object","properties":{"CampaignCode":{"type":"string"},"Name":{"type":"string"},"MasterProducts":{"type":"array","items":{"type":"string"}},"DisplayType":{"type":"string","enum":["cart","review","finish"]},"DisplayInEmail":{"type":"boolean"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Response"}},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"Errors":{"type":"array","items":{"type":"string","description":"Validation errors, will be empty in case of successful request"}}}},"CrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","format":"float","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"Errors":{"type":"array","items":{"type":"string"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The GetCrossSellResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetCrossSellResponse":{"type":"object","properties":{"CampaignCode":{"type":"string"},"Name":{"type":"string","enum":["cart","review","finish"]},"CampaignStatus":{"type":"string","enum":["ACTIVE","DISABLED"]},"CampaignOwnerType":{"type":"string","enum":["MERCH","AFF"]},"MasterProducts":{"type":"array","items":{"type":"string"}},"DisplayType":{"type":"string","enum":["cart","review","finish"]},"DisplayInEmail":{"type":"boolean"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/GetCrossSellProduct_Response"}},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"GetCrossSellProduct_Response":{"required":["Discount","DiscountType","ProductCode","DiscountedPrice","BasePrice"],"type":"object","properties":{"ProductCode":{"type":"string","description":"product code id of a product that will be suggested"},"Discount":{"type":"number","description":"Discount number (in percent), between 0-100"},"DiscountType":{"type":"string","description":"can only be 'PERCENT'","enum":["PERCENT"]},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"BasePrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductBasePrice"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The CrossSellResponseException object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellResponseException":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The CrossSellTextsRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellTextsRequest":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellTextRequest"}},"CrossSellTextRequest":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Title":{"type":"string","description":"campaign title in the related language"},"Description":{"type":"string","description":"campaign description in the related language"}}}}}} ``` ## The CrossSellTextRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellTextRequest":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Title":{"type":"string","description":"campaign title in the related language"},"Description":{"type":"string","description":"campaign description in the related language"}}}}}} ``` ## The CrossSellTextsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellTextsResponse":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellTextResponse"}},"CrossSellTextResponse":{"allOf":[{"$ref":"#/components/schemas/CrossSellTextRequest"},{"type":"object","properties":{"Errors":{"type":"array","items":{"type":"string"}}}}]},"CrossSellTextRequest":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Title":{"type":"string","description":"campaign title in the related language"},"Description":{"type":"string","description":"campaign description in the related language"}}}}}} ``` ## The CrossSellTextResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellTextResponse":{"allOf":[{"$ref":"#/components/schemas/CrossSellTextRequest"},{"type":"object","properties":{"Errors":{"type":"array","items":{"type":"string"}}}}]},"CrossSellTextRequest":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Title":{"type":"string","description":"campaign title in the related language"},"Description":{"type":"string","description":"campaign description in the related language"}}}}}} ``` ## The UpsellDisplayTypeResponseException object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellDisplayTypeResponseException":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The ProductImagesListResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductImagesListResponse":{"type":"array","items":{"$ref":"#/components/schemas/ProductImageResponse"}},"ProductImageResponse":{"type":"object","properties":{"Default":{"type":"boolean"},"URL":{"type":"string"}}}}}} ``` ## The CrossSellCampaignSearchResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellCampaignSearchResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellCampaign"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"CrossSellCampaign":{"type":"object","properties":{"IdCrossSellingCampaign":{"type":"number"},"Name":{"type":"string"},"CampaignCode":{"type":"string"},"DisplayType":{"type":"string","enum":["cart","review","finish"]},"ProductCode":{"type":"string","enum":["cart","review","finish"]},"MasterProducts":{"type":"array","items":{"type":"string"}},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Search"}}}},"CrossSellProduct_Search":{"type":"object","properties":{"ProductCode":{"type":"string"},"Discount":{"type":"integer"},"DiscountType":{"type":"string","enum":["PERCENT"]},"Type":{"type":"string","enum":["Network","Own"]},"AutoAdded":{"type":"boolean"},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"BasePrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductBasePrice"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The UpsellCampaignSettingsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignSettingsResponse":{"type":"object","properties":{"UpsellingDisplayType":{"type":"string"}}}}}} ``` ## The CrossSellCampaignSearchError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellCampaignSearchError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The CrossSellCampaign object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellCampaign":{"type":"object","properties":{"IdCrossSellingCampaign":{"type":"number"},"Name":{"type":"string"},"CampaignCode":{"type":"string"},"DisplayType":{"type":"string","enum":["cart","review","finish"]},"ProductCode":{"type":"string","enum":["cart","review","finish"]},"MasterProducts":{"type":"array","items":{"type":"string"}},"Products":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProduct_Search"}}}},"CrossSellProduct_Search":{"type":"object","properties":{"ProductCode":{"type":"string"},"Discount":{"type":"integer"},"DiscountType":{"type":"string","enum":["PERCENT"]},"Type":{"type":"string","enum":["Network","Own"]},"AutoAdded":{"type":"boolean"},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"BasePrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductBasePrice"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The Partner object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Partner":{"type":"object","properties":{"UUID":{"type":"string"},"PartnerCode":{"type":"string"},"CompanyCommercialName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"StateOrProvince":{"type":"string"},"Zip":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"Email":{"type":"string"},"Website":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"CommunicationLanguage":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The CreatePartnerRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreatePartnerRequest":{"type":"object","properties":{"PartnerCode":{"type":"string"},"CompanyCommercialName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"StateOrProvince":{"type":"string"},"Zip":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"Email":{"type":"string"},"Website":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"CommunicationLanguage":{"type":"string"},"Country":{"type":"string"},"FinancialDetails":{"type":"object","properties":{"CompanyRegistrationName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"Country":{"type":"string"},"State":{"type":"string"},"GenerateInvoiceMethod":{"type":"string","enum":["MANUAL","AUTOMATIC_FOREACH_ORDER","AUTOMATIC_ON_SPECIFIC_DAY"]},"CanCreateProformas":{"type":"integer","enum":[0,1]}}}}}}}} ``` ## The PartnersSearchResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnersSearchResponse":{"type":"array","items":{"type":"object","properties":{"UUID":{"type":"string"},"PartnerCode":{"type":"string"},"CompanyCommercialName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"StateOrProvince":{"type":"string"},"Zip":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"Email":{"type":"string"},"Website":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"CommunicationLanguage":{"type":"string"},"Country":{"type":"string"},"Currency":{"type":"string"},"Status":{"type":"string","enum":["PENDING","ACTIVE","INACTIVE","REJECTED"]},"FinancialDetails":{"type":"object","properties":{"CompanyRegistrationName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"Country":{"type":"string"},"State":{"type":"string"},"GenerateInvoiceMethod":{"type":"string","enum":["MANUAL","AUTOMATIC_FOREACH_ORDER","AUTOMATIC_ON_SPECIFIC_DAY"]},"CanCreateProformas":{"type":"integer","enum":[0,1]}}}}}}}}} ``` ## The PartnersGetResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnersGetResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Partner"}}}},"Partner":{"type":"object","properties":{"UUID":{"type":"string"},"PartnerCode":{"type":"string"},"CompanyCommercialName":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"StateOrProvince":{"type":"string"},"Zip":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"Email":{"type":"string"},"Website":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"CommunicationLanguage":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The Reseller object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Reseller":{"type":"object","properties":{"ResellerCode":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"Address":{"type":"string"},"State":{"type":"string"},"PostalCode":{"type":"string"},"Phone":{"type":"string"},"Country":{"type":"string"},"Fax":{"type":"string"},"PartnerCode":{"type":"string"}}}}}} ``` ## The ResellersGetResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ResellersGetResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Reseller"}}}},"Reseller":{"type":"object","properties":{"ResellerCode":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"Address":{"type":"string"},"State":{"type":"string"},"PostalCode":{"type":"string"},"Phone":{"type":"string"},"Country":{"type":"string"},"Fax":{"type":"string"},"PartnerCode":{"type":"string"}}}}}} ``` ## The CreateResellerRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreateResellerRequest":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"Email":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"PostalCode":{"type":"string"},"Country":{"type":"string"},"State":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"PartnerCode":{"type":"string"}}}}}} ``` ## The UpdateOrderResellerRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateOrderResellerRequest":{"type":"object","properties":{"PartnerCode":{"type":"string"},"ResellerCode":{"type":"string"},"OrderRefNo":{"type":"integer"}}}}}} ``` ## The UpdateResellerRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateResellerRequest":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"Email":{"type":"string"},"Address":{"type":"string"},"City":{"type":"string"},"PostalCode":{"type":"string"},"Country":{"type":"string"},"State":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"PartnerCode":{"type":"string"},"ResellerCode":{"type":"string"}}}}}} ``` ## The PartnerUser object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerUser":{"type":"object","properties":{"UUID":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"Status":{"type":"string"}}}}}} ``` ## The CreatePartnerUserRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreatePartnerUserRequest":{"$ref":"#/components/schemas/PartnerUserRequest"},"PartnerUserRequest":{"required":["Email","FirstName","LastName","PhoneNumber","Status"],"type":"object","properties":{"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"Status":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}}}} ``` ## The UpdatePartnerUserRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdatePartnerUserRequest":{"$ref":"#/components/schemas/PartnerUserRequest"},"PartnerUserRequest":{"required":["Email","FirstName","LastName","PhoneNumber","Status"],"type":"object","properties":{"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"Status":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}}}} ``` ## The PartnerUserRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnerUserRequest":{"required":["Email","FirstName","LastName","PhoneNumber","Status"],"type":"object","properties":{"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Position":{"type":"string"},"PhoneNumber":{"type":"string"},"MobilePhone":{"type":"string"},"Status":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}}}} ``` ## The PartnersSearchError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PartnersSearchError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The CrossSellProduct\_Search object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellProduct_Search":{"type":"object","properties":{"ProductCode":{"type":"string"},"Discount":{"type":"integer"},"DiscountType":{"type":"string","enum":["PERCENT"]},"Type":{"type":"string","enum":["Network","Own"]},"AutoAdded":{"type":"boolean"},"DiscountedPrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductDiscountedPrice"}},"BasePrice":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellProductBasePrice"}}}},"CrossSellProductDiscountedPrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}},"CrossSellProductBasePrice":{"type":"object","properties":{"Currency":{"type":"string"},"Price":{"type":"number"}}}}}} ``` ## The UpsellCreate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCreate":{"type":"object","properties":{"Name":{"type":"string","description":"Name of campaign, max 500 chars."},"StartDate":{"type":"string","description":"When will campaign start","nullable":true},"EndDate":{"type":"string","description":"When should campaign end","nullable":true},"DisplayForManualRenewals":{"type":"boolean","description":"Flag that controls compaign display for manual renewals"},"Discount":{"oneOf":[{"$ref":"#/components/schemas/UpsellCampaignDiscountFixed"},{"$ref":"#/components/schemas/UpsellCampaignDiscountPercent"}]},"PrimaryProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"RecommendedProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"Enabled":{"type":"boolean","description":"Flag that controls if the compaign is enabled"},"Description":{"type":"array","description":"The list of campaign language descriptions","items":{"$ref":"#/components/schemas/UpsellCampaignLanguageDescription"}}},"required":["Name","DisplayForManualRenewals","Discount","PrimaryProduct","RecommendedProduct","Enabled","Description"]},"UpsellCampaignDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"discount default currency"}}},"UpsellCampaignDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"integer","description":"price discount amount"}}},"UpsellCampaignDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}},"UpsellCampaignProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Product quantity (0 means any quantity)"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOption"}}}},"UpsellCampaignProductPriceOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option code"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOptionOption"}}}},"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}},"UpsellCampaignLanguageDescription":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Text":{"type":"string","description":"campaign text in the specified language code"}}}}}} ``` ## The UpsellCampaignDiscountFixed object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"discount default currency"}}},"UpsellCampaignDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"integer","description":"price discount amount"}}}}}} ``` ## The UpsellCampaignDiscountAmount object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"integer","description":"price discount amount"}}}}}} ``` ## The UpsellCampaignDiscountPercent object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}}}}} ``` ## The UpsellCampaignProduct object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Product quantity (0 means any quantity)"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOption"}}}},"UpsellCampaignProductPriceOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option code"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOptionOption"}}}},"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}}}}} ``` ## The UpsellCampaignProductPriceOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignProductPriceOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option code"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOptionOption"}}}},"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}}}}} ``` ## The UpsellCampaignProductPriceOptionOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}}}}} ``` ## The UpsellCampaignLanguageDescription object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellCampaignLanguageDescription":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Text":{"type":"string","description":"campaign text in the specified language code"}}}}}} ``` ## The UpsellResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellResponse":{"type":"object","properties":{"Code":{"type":"string","description":"Uniquely generated campaign code"},"Name":{"type":"string","description":"Name of campaign"},"StartDate":{"type":"string","description":"When will campaign start","nullable":true},"EndDate":{"type":"string","description":"When will campaign end","nullable":true},"DisplayForManualRenewals":{"type":"boolean","description":"Flag that controls compaign display for manual renewals"},"Discount":{"oneOf":[{"$ref":"#/components/schemas/UpsellCampaignDiscountFixed"},{"$ref":"#/components/schemas/UpsellCampaignDiscountPercent"}]},"PrimaryProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"RecommendedProduct":{"$ref":"#/components/schemas/UpsellCampaignProduct"},"Enabled":{"type":"boolean","description":"Flag that controls if the compaign is enabled"},"Description":{"type":"array","description":"The list of campaign language descriptions","items":{"$ref":"#/components/schemas/UpsellCampaignLanguageDescription"}}}},"UpsellCampaignDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"discount default currency"}}},"UpsellCampaignDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"integer","description":"price discount amount"}}},"UpsellCampaignDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}},"UpsellCampaignProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Product quantity (0 means any quantity)"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOption"}}}},"UpsellCampaignProductPriceOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option code"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/UpsellCampaignProductPriceOptionOption"}}}},"UpsellCampaignProductPriceOptionOption":{"type":"object","properties":{"Code":{"type":"string","description":"Price option option code"},"Value":{"type":"integer","description":"Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)","nullable":true}}},"UpsellCampaignLanguageDescription":{"type":"object","properties":{"Language":{"type":"string","description":"language code"},"Text":{"type":"string","description":"campaign text in the specified language code"}}}}}} ``` ## The UpsellResponseException object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpsellResponseException":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The DeleteUpsellResponseException object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeleteUpsellResponseException":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The ProductUpgradeSchemaRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductUpgradeSchemaRequest":{"type":"object","properties":{"AllowUpgradeFrom":{"type":"array","description":"The list of the codes of products that can be upgraded to the product specified","items":{"type":"string"}},"UpgradeSettings":{"$ref":"#/components/schemas/ProductUpgradeSettings"}},"required":["AllowUpgradeFrom","UpgradeSettings"]},"ProductUpgradeSettings":{"type":"object","properties":{"PricingScheme":{"type":"integer","description":"The pricing option scheme for the upgrade: 1 (full price), 2 (price difference), 3 (prorated with most recent costs), 4 (prorated with price setup)"},"OptionPriceOperator":{"type":"string","description":"The price option operator to be used when calculating the upgrade price percentage (in not prorated pricing scheme): ADD or SUBSTRACT"},"OptionPricePercentage":{"type":"integer","description":"The percentage to be added/substracted to/from the upgrade price (in not prorated pricing scheme)"},"SubscriptionUpgradeType":{"type":"integer","description":"The subscription period option for the upgrade product: 3 (same lifetime), 1 (new subscription), 2 (prolong subscription from the upgrade date)"},"UseProductCatalogPricing":{"type":"boolean","default":false,"description":"Controls if custom prices for the upgrade product are disabled or not (default false)"},"ProrateIgnoreGracePeriod":{"type":"boolean","description":"Controls if renewal grace period is ignored at prorated upgrade price calculation (default false)"},"ApplyExistingDiscountToRenewalsAfterUpgrade":{"type":"boolean","description":"Controls if should apply an existing discount to future renewals following an upgrade (default false)"}},"required":["PricingScheme","SubscriptionUpgradeType"]}}}} ``` ## The ProductUpgradeSettings object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductUpgradeSettings":{"type":"object","properties":{"PricingScheme":{"type":"integer","description":"The pricing option scheme for the upgrade: 1 (full price), 2 (price difference), 3 (prorated with most recent costs), 4 (prorated with price setup)"},"OptionPriceOperator":{"type":"string","description":"The price option operator to be used when calculating the upgrade price percentage (in not prorated pricing scheme): ADD or SUBSTRACT"},"OptionPricePercentage":{"type":"integer","description":"The percentage to be added/substracted to/from the upgrade price (in not prorated pricing scheme)"},"SubscriptionUpgradeType":{"type":"integer","description":"The subscription period option for the upgrade product: 3 (same lifetime), 1 (new subscription), 2 (prolong subscription from the upgrade date)"},"UseProductCatalogPricing":{"type":"boolean","default":false,"description":"Controls if custom prices for the upgrade product are disabled or not (default false)"},"ProrateIgnoreGracePeriod":{"type":"boolean","description":"Controls if renewal grace period is ignored at prorated upgrade price calculation (default false)"},"ApplyExistingDiscountToRenewalsAfterUpgrade":{"type":"boolean","description":"Controls if should apply an existing discount to future renewals following an upgrade (default false)"}},"required":["PricingScheme","SubscriptionUpgradeType"]}}}} ``` ## The ProductUpgradeSchemaErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductUpgradeSchemaErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The Pagination object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The CrossSellSearchError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellSearchError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The CrossSellSetting object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellSetting":{"required":["displayProductsMax","maxThumbSize"],"type":"object","properties":{"displayProductsMax":{"type":"integer"},"maxThumbSize":{"type":"integer","enum":[60,80,100,150]},"displayShortDescription":{"type":"boolean"}}}}}} ``` ## The CrossSellError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CrossSellError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The PlaceOrder object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder":{"type":"object","properties":{"Language":{"type":"string"},"Country":{"type":"string"},"CustomerIP":{"type":"string"},"Source":{"type":"string"},"WSOrder":{"type":"string"},"ExternalCustomerReference":{"type":"string"},"Currency":{"type":"string"},"Promotions":{"type":"array","items":{"type":"string"}},"Affiliate":{"$ref":"#/components/schemas/orders0_Affiliate"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_Items"}},"BillingCycleReset":{"type":"boolean","description":"Only used when the request type is \"Place an order with manual renewal\". Licence renewal will start immediately upon processing the new order, resetting the billing cycle."},"BillingDetails":{"$ref":"#/components/schemas/PlaceOrder_BillingDetails"},"PaymentDetails":{"$ref":"#/components/schemas/PlaceOrder_PaymentDetails"},"ExtraInformation":{"$ref":"#/components/schemas/PlaceOrder_ExtraInformation"}}},"orders0_Affiliate":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"AffiliateSource":{"type":"string"}}},"PlaceOrder_Items":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code defined for your product."},"RenewalInformation":{"$ref":"#/components/schemas/PlaceOrder_RenewalInformation"},"UpgradeInformation":{"$ref":"#/components/schemas/PlaceOrder_UpgradeInformation"},"Name":{"type":"string"},"Description":{"type":"string"},"Quantity":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"Price":{"$ref":"#/components/schemas/PlaceOrder_Price"},"ProductTaxCategoryUUID":{"type":"string"},"PriceType":{"type":"string"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_PriceOptions"}},"CrossSell":{"$ref":"#/components/schemas/PlaceOrder_ItemCrossSell"},"UpSell":{"$ref":"#/components/schemas/PlaceOrder_ItemUpSell"},"RecurringOptions":{"$ref":"#/components/schemas/PlaceOrder_RecurringOptions"},"SubscriptionCustomSettings":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"},"Trial":{"$ref":"#/components/schemas/PlaceOrder_TrialInput"},"Promotion":{"$ref":"#/components/schemas/PlaceOrder_ItemPromotion"}}},"PlaceOrder_RenewalInformation":{"type":"object","description":"Used for manual renewal orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be renewed."},"Code":{"type":"string","description":"The unique code defined for your product. Required for manual renewal only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for manual renewal only if you wish to change the product quantity on the subscription."}}},"PlaceOrder_UpgradeInformation":{"type":"object","description":"Used for upgrade orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be upgraded."},"Code":{"type":"string","description":"The unique code defined for your product. Required for upgrade order only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for upgrade order only if you wish to change the product quantity on the subscription."}}},"PlaceOrder_Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"PlaceOrder_PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_Options"}}}},"PlaceOrder_Options":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"integer"}}},"PlaceOrder_ItemCrossSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"AutoAdded":{"type":"boolean"}}},"PlaceOrder_ItemUpSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"PriceOptions":{"type":"array","items":{"type":"string"}},"Quantity":{"type":"integer"}}},"PlaceOrder_RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"]},"CycleAmount":{"type":"number"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR","FOREVER"]}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"PlaceOrder_TrialInput":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}},"PlaceOrder_ItemPromotion":{"type":"object","properties":{"Code":{"type":"string"}}},"PlaceOrder_BillingDetails":{"required":["Address1","City","CountryCode","Email","FirstName","LastName","State","Zip"],"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Zip":{"type":"string"}}},"PlaceOrder_PaymentDetails":{"required":["Currency","Type"],"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string","description":"The currency ISO code for the payment - ISO 4217. Can be changed for the method \"Place an order with manual renewal\" to set a common currency for multiple subscriptions renewed via the same order."},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/PlaceOrder_PaymentDetails_PaymentMethod"}}},"PlaceOrder_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardNumber":{"type":"string"},"CardType":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"},"ExpirationYear":{"type":"string"},"ExpirationMonth":{"type":"string"},"CCID":{"type":"string"},"HolderName":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"HolderNameTime":{"type":"integer"},"CardNumberTime":{"type":"integer"}}},"PlaceOrder_ExtraInformation":{"type":"object","properties":{"RetryFailedPaymentLink":{"type":"string","format":"url","description":"One of the url query params must be \"[REFNO]\""},"ProposalId":{"type":"string","maximum":36},"PurchaseOrderDownloadLink":{"type":"string","format":"url"},"AssistedSale":{"type":"boolean"},"AssistedSaleAccountManagerEmail":{"type":"string"}}}}}} ``` ## The OrderReference object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"OrderReference":{"type":"string"}}}} ``` ## The CancelRefundReference200 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CancelRefundReference200":{"type":"object","properties":{"RefundId":{"type":"string"}}}}}} ``` ## The CancelRefundReference400 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CancelRefundReference400":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The RefundableInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RefundableInformation":{"type":"object","description":"Information about refundable amounts and line items for an order","properties":{"TotalRefundableAmount":{"type":"number","format":"float","description":"Total refundable amount remaining on the order"},"LineItems":{"type":"array","description":"Line items available for refund","items":{"$ref":"#/components/schemas/RefundableLineItem"}}}},"RefundableLineItem":{"type":"object","description":"Individual line item available for refund","properties":{"LineItemReference":{"type":"string","description":"Unique reference for the line item"},"ProductCode":{"type":"string","description":"Product code"},"AvailableQuantity":{"type":"integer","description":"Quantity available for refund"},"AvailableAmount":{"type":"number","format":"float","description":"Amount available for refund"}}}}}} ``` ## The RefundableLineItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RefundableLineItem":{"type":"object","description":"Individual line item available for refund","properties":{"LineItemReference":{"type":"string","description":"Unique reference for the line item"},"ProductCode":{"type":"string","description":"Product code"},"AvailableQuantity":{"type":"integer","description":"Quantity available for refund"},"AvailableAmount":{"type":"number","format":"float","description":"Amount available for refund"}}}}}} ``` ## The RefundDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RefundDetails":{"type":"object","description":"Detailed information about a refund request","properties":{"RequestStatus":{"type":"string","description":"Status of the refund request","enum":["APPROVED","PENDING","REJECTED","CANCELLED"]},"RequestDate":{"type":"string","description":"Date when the refund was requested","format":"date-time"},"RequestApprovedDate":{"type":"string","description":"Date when the refund was approved","format":"date-time"},"RequestAmount":{"type":"number","format":"float","description":"Amount of the refund"},"RequestReason":{"type":"string","description":"Reason for the refund"},"Type":{"type":"string","description":"Type of refund","enum":["FULL","PARTIAL"]},"LineItems":{"type":"array","description":"Line items included in this refund","items":{"$ref":"#/components/schemas/RefundLineItem"}}}},"RefundLineItem":{"type":"object","description":"Individual line item included in a refund","properties":{"LineItemReference":{"type":"string","description":"Unique reference for the line item"},"ProductCode":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Quantity refunded"},"Amount":{"type":"number","format":"float","description":"Amount refunded for this line item"}}}}}} ``` ## The RefundLineItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RefundLineItem":{"type":"object","description":"Individual line item included in a refund","properties":{"LineItemReference":{"type":"string","description":"Unique reference for the line item"},"ProductCode":{"type":"string","description":"Product code"},"Quantity":{"type":"integer","description":"Quantity refunded"},"Amount":{"type":"number","format":"float","description":"Amount refunded for this line item"}}}}}} ``` ## The OrderReferenceSaleBadRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"OrderReferenceSaleBadRequest":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The OrderReferenceInvoiceBadRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"OrderReferenceInvoiceBadRequest":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The DeleteSkuPriceConfiguration object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeleteSkuPriceConfiguration":{"type":"object","properties":{"PriceConfigurationCode":{"type":"string"},"SKUs":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The DeleteSkuProduct object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeleteSkuProduct":{"type":"object","properties":{"ProductCode":{"type":"string"},"PriceConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/DeleteSkuPriceConfiguration"}},"SKUs":{"type":"array","items":{"type":"string"}}}},"DeleteSkuPriceConfiguration":{"type":"object","properties":{"PriceConfigurationCode":{"type":"string"},"SKUs":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The DeleteSkuPriceConfigurationResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeleteSkuPriceConfigurationResponse":{"type":"object","properties":{"PriceConfigurationCode":{"type":"string"},"SKUs":{"type":"array","items":{"type":"string"}},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The DeleteSkuProductResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeleteSkuProductResponse":{"type":"object","properties":{"ProductCode":{"type":"string"},"PriceConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/DeleteSkuPriceConfigurationResponse"}},"SKUs":{"type":"array","items":{"type":"string"}},"Errors":{"type":"array","items":{"type":"string"}}}},"DeleteSkuPriceConfigurationResponse":{"type":"object","properties":{"PriceConfigurationCode":{"type":"string"},"SKUs":{"type":"array","items":{"type":"string"}},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The ShippingFeeResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ShippingFeeResponse":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Amount":{"type":"string"},"Currency":{"type":"string"},"ApplyTo":{"type":"string"},"Type":{"type":"string"}}}}}} ``` ## The ProductImageResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductImageResponse":{"type":"object","properties":{"Default":{"type":"boolean"},"URL":{"type":"string"}}}}}} ``` ## The ShippingFeesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ShippingFeesResponse":{"type":"array","items":{"$ref":"#/components/schemas/ShippingFeeResponse"}},"ShippingFeeResponse":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Amount":{"type":"string"},"Currency":{"type":"string"},"ApplyTo":{"type":"string"},"Type":{"type":"string"}}}}}} ``` ## The SearchShippingMethods object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchShippingMethods":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SearchShippingMethodsItems"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"SearchShippingMethodsItems":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"TrackingUrl":{"type":"string"},"BasePrice":{"type":"integer"},"Currency":{"type":"string"},"Active":{"type":"boolean"},"Availability":{"type":"string"},"Countries":{"type":"array","items":{"$ref":"#/components/schemas/SearchShippingMethodsCountries"}},"Surcharge":{"type":"array","items":{"$ref":"#/components/schemas/SearchShippingMethodsSurcharge"}}}},"SearchShippingMethodsCountries":{"type":"object","properties":{"CountryCode":{"type":"string"},"Surcharge":{"type":"string"}}},"SearchShippingMethodsSurcharge":{"type":"object","properties":{"Type":{"type":"string"},"From":{"type":"number"},"To":{"type":"integer"},"Amount":{"type":"integer"},"ApplyTo":{"type":"string"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The SearchShippingMethodsItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchShippingMethodsItems":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"TrackingUrl":{"type":"string"},"BasePrice":{"type":"integer"},"Currency":{"type":"string"},"Active":{"type":"boolean"},"Availability":{"type":"string"},"Countries":{"type":"array","items":{"$ref":"#/components/schemas/SearchShippingMethodsCountries"}},"Surcharge":{"type":"array","items":{"$ref":"#/components/schemas/SearchShippingMethodsSurcharge"}}}},"SearchShippingMethodsCountries":{"type":"object","properties":{"CountryCode":{"type":"string"},"Surcharge":{"type":"string"}}},"SearchShippingMethodsSurcharge":{"type":"object","properties":{"Type":{"type":"string"},"From":{"type":"number"},"To":{"type":"integer"},"Amount":{"type":"integer"},"ApplyTo":{"type":"string"}}}}}} ``` ## The SearchShippingMethodsSurcharge object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchShippingMethodsSurcharge":{"type":"object","properties":{"Type":{"type":"string"},"From":{"type":"number"},"To":{"type":"integer"},"Amount":{"type":"integer"},"ApplyTo":{"type":"string"}}}}}} ``` ## The SearchShippingMethodsCountries object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchShippingMethodsCountries":{"type":"object","properties":{"CountryCode":{"type":"string"},"Surcharge":{"type":"string"}}}}}} ``` ## The SearchPayouts object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchPayouts":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SearchPayoutsItems"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"SearchPayoutsItems":{"type":"object","properties":{"TransferCompletionDate":{"type":"string"},"PaymentType":{"type":"string"},"Amount":{"type":"number"},"TotalSales":{"type":"number"},"TotalFees":{"type":"number"},"TotalRefunds":{"type":"number"},"Currency":{"type":"string"},"Status":{"type":"string"},"Invoices":{"type":"array","items":{"$ref":"#/components/schemas/SearchPayoutsInvoices"}},"Summary":{"$ref":"#/components/schemas/SearchPayoutsItems_Summary"}}},"SearchPayoutsInvoices":{"type":"object","properties":{"Reference":{"type":"string"},"Amount":{"type":"number"},"Description":{"type":"string"},"Type":{"type":"string"},"Code":{"type":"string"},"Date":{"type":"string"},"PaidAmount":{"type":"number"},"PaidDate":{"type":"string"},"PaidCurrency":{"type":"string"},"RetainedAmount":{"type":"number"},"ReleasedAmount":{"type":"number"}}},"SearchPayoutsItems_Summary":{"type":"object","properties":{"ServicesAmount":{"type":"number"},"PurchaseOrdersAmount":{"type":"number"},"ChargeBacksAmount":{"type":"number"},"RollingReserveAmount":{"type":"number"},"PeriodNetSales":{"type":"number"},"VendorToVendor":{"type":"number"},"ChargeBackFund":{"type":"number"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The SearchPayoutsItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchPayoutsItems":{"type":"object","properties":{"TransferCompletionDate":{"type":"string"},"PaymentType":{"type":"string"},"Amount":{"type":"number"},"TotalSales":{"type":"number"},"TotalFees":{"type":"number"},"TotalRefunds":{"type":"number"},"Currency":{"type":"string"},"Status":{"type":"string"},"Invoices":{"type":"array","items":{"$ref":"#/components/schemas/SearchPayoutsInvoices"}},"Summary":{"$ref":"#/components/schemas/SearchPayoutsItems_Summary"}}},"SearchPayoutsInvoices":{"type":"object","properties":{"Reference":{"type":"string"},"Amount":{"type":"number"},"Description":{"type":"string"},"Type":{"type":"string"},"Code":{"type":"string"},"Date":{"type":"string"},"PaidAmount":{"type":"number"},"PaidDate":{"type":"string"},"PaidCurrency":{"type":"string"},"RetainedAmount":{"type":"number"},"ReleasedAmount":{"type":"number"}}},"SearchPayoutsItems_Summary":{"type":"object","properties":{"ServicesAmount":{"type":"number"},"PurchaseOrdersAmount":{"type":"number"},"ChargeBacksAmount":{"type":"number"},"RollingReserveAmount":{"type":"number"},"PeriodNetSales":{"type":"number"},"VendorToVendor":{"type":"number"},"ChargeBackFund":{"type":"number"}}}}}} ``` ## The SearchPayoutsInvoices object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchPayoutsInvoices":{"type":"object","properties":{"Reference":{"type":"string"},"Amount":{"type":"number"},"Description":{"type":"string"},"Type":{"type":"string"},"Code":{"type":"string"},"Date":{"type":"string"},"PaidAmount":{"type":"number"},"PaidDate":{"type":"string"},"PaidCurrency":{"type":"string"},"RetainedAmount":{"type":"number"},"ReleasedAmount":{"type":"number"}}}}}} ``` ## The PendingPayouts object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PendingPayouts":{"type":"object","properties":{"Currencies":{"type":"array","items":{"$ref":"#/components/schemas/PendingPayoutsCurrencies"}},"Total":{"$ref":"#/components/schemas/PendingPayouts_Total"}}},"PendingPayoutsCurrencies":{"type":"object","properties":{"Currency":{"type":"string"},"OrdersTotal":{"$ref":"#/components/schemas/PendingPayoutsCurrencies_OrdersTotal"},"RetainedToDisputesBalance":{"type":"number"},"ReleasedFromDisputesBalance":{"type":"number"},"RetainedToRollingReserveBalance":{"type":"number"},"ReleasedFromRollingReserveBalance":{"type":"number"},"ChargebackFees":{"type":"number"},"ProcessingFees":{"type":"number"},"AffiliatesCommission":{"type":"number"},"TaxCollected":{"type":"number"},"EstimatedTotalRevenue":{"type":"number"}}},"PendingPayoutsCurrencies_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}},"PendingPayouts_Total":{"type":"object","properties":{"Currency":{"type":"string"},"OrdersTotal":{"$ref":"#/components/schemas/PendingPayouts_Total_OrdersTotal"},"RetainedToDisputesBalance":{"type":"number"},"ReleasedFromDisputesBalance":{"type":"number"},"RetainedToRollingReserveBalance":{"type":"number"},"ReleasedFromRollingReserveBalance":{"type":"number"},"ChargebackFees":{"type":"number"},"ProcessingFees":{"type":"number"},"AffiliatesCommission":{"type":"number"},"TaxCollected":{"type":"number"},"EstimatedTotalRevenue":{"type":"number"}}},"PendingPayouts_Total_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}}}}} ``` ## The PendingPayoutsCurrencies object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PendingPayoutsCurrencies":{"type":"object","properties":{"Currency":{"type":"string"},"OrdersTotal":{"$ref":"#/components/schemas/PendingPayoutsCurrencies_OrdersTotal"},"RetainedToDisputesBalance":{"type":"number"},"ReleasedFromDisputesBalance":{"type":"number"},"RetainedToRollingReserveBalance":{"type":"number"},"ReleasedFromRollingReserveBalance":{"type":"number"},"ChargebackFees":{"type":"number"},"ProcessingFees":{"type":"number"},"AffiliatesCommission":{"type":"number"},"TaxCollected":{"type":"number"},"EstimatedTotalRevenue":{"type":"number"}}},"PendingPayoutsCurrencies_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}}}}} ``` ## The LeadResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"CreatedAt":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/LeadResponse_Errors"}}}},"LeadResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The UpdateLeadResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateLeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"CreatedAt":{"type":"string"},"UpdatedAt":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/LeadResponse_Errors"}}}},"LeadResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The GetLeadResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"GeneratedFrom":{"type":"string"},"CartId":{"type":"string"},"Currency":{"type":"string"},"Language":{"type":"string"},"ExternalReference":{"type":"string"},"MachineId":{"type":"string"},"Items":{"$ref":"#/components/schemas/GetLeadResponse_Items"},"BillingDetails":{"$ref":"#/components/schemas/GetLeadResponse_BillingDetails"},"DeliveryDetails":{"$ref":"#/components/schemas/GetLeadResponse_DeliveryDetails"},"DeliveryInformation":{"$ref":"#/components/schemas/GetLeadResponse_DeliveryInformation"},"PaymentDetails":{"$ref":"#/components/schemas/GetLeadResponse_PaymentDetails"},"Promotions":{"type":"array","items":{"$ref":"#/components/schemas/GetLeadResponse_Promotions"}},"LocalTime":{"type":"string"}}},"GetLeadResponse_Items":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Item"}}},"Item":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"integer"},"SKU":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"PriceOptions":{"$ref":"#/components/schemas/Item_PriceOptions"},"RecurringOptions":{"$ref":"#/components/schemas/Item_RecurringOptions"},"MarketingCampaigns":{"$ref":"#/components/schemas/Item_MarketingCampaigns"},"Price":{"$ref":"#/components/schemas/Item_Price"},"AdditionalFields":{"$ref":"#/components/schemas/Item_AdditionalFields"},"SubscriptionStartDate":{"type":"string"},"Trial":{"$ref":"#/components/schemas/LeadTrial"}}},"Item_PriceOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptions"}}},"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}},"Item_RecurringOptions":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/RecurringOptions"}}},"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}},"Item_MarketingCampaigns":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/MarketingCampaigns"}}},"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}},"Item_Price":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Price"}}},"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"Item_AdditionalFields":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFields"}}},"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}},"LeadTrial":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}},"GetLeadResponse_BillingDetails":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/BillingDetails"}}},"BillingDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"GetLeadResponse_DeliveryDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"GetLeadResponse_DeliveryInformation":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryInformation"}}},"DeliveryInformation":{"type":"object","properties":{"ShippingMethod":{"$ref":"#/components/schemas/DeliveryInformation_ShippingMethod"}}},"DeliveryInformation_ShippingMethod":{"type":"object","properties":{"Code":{"type":"string"}}},"GetLeadResponse_PaymentDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PaymentDetails"}}},"PaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"PaymentMethod":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod"},"CustomerIP":{"type":"string"}}},"PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardPayment":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod_CardPayment"}}},"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}},"GetLeadResponse_Promotions":{"type":"object","properties":{"0":{"type":"string"}}}}}} ``` ## The Item object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"integer"},"SKU":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"PriceOptions":{"$ref":"#/components/schemas/Item_PriceOptions"},"RecurringOptions":{"$ref":"#/components/schemas/Item_RecurringOptions"},"MarketingCampaigns":{"$ref":"#/components/schemas/Item_MarketingCampaigns"},"Price":{"$ref":"#/components/schemas/Item_Price"},"AdditionalFields":{"$ref":"#/components/schemas/Item_AdditionalFields"},"SubscriptionStartDate":{"type":"string"},"Trial":{"$ref":"#/components/schemas/LeadTrial"}}},"Item_PriceOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptions"}}},"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}},"Item_RecurringOptions":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/RecurringOptions"}}},"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}},"Item_MarketingCampaigns":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/MarketingCampaigns"}}},"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}},"Item_Price":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Price"}}},"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"Item_AdditionalFields":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFields"}}},"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}},"LeadTrial":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}}}}} ``` ## The PriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}}}}} ``` ## The PriceOptionsOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}}}}} ``` ## The LeadTrial object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LeadTrial":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}}}}} ``` ## The RecurringOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}}}}} ``` ## The MarketingCampaigns object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}}}}} ``` ## The Price object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}}}}} ``` ## The AdditionalFields object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"BillingDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The DeliveryDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The DeliveryInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryInformation":{"type":"object","properties":{"ShippingMethod":{"$ref":"#/components/schemas/DeliveryInformation_ShippingMethod"}}},"DeliveryInformation_ShippingMethod":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The PaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"PaymentMethod":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod"},"CustomerIP":{"type":"string"}}},"PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardPayment":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod_CardPayment"}}},"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The SubscriptionResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SubscriptionResponse":{"type":"object","properties":{"SubscriptionReference":{"type":"string"},"StartDate":{"type":"string"},"ActivationDate":{"type":"string"},"ExpirationDate":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"NextBillingDate":{"type":"string","default":"null","minLength":0,"maxLength":25},"SubscriptionEnabled":{"type":"boolean"},"Product":{"$ref":"#/components/schemas/Product"},"EndUser":{"$ref":"#/components/schemas/EndUser"},"SKU":{"type":"string"},"DeliveryInfo":{"$ref":"#/components/schemas/DeliveryInfo"},"ReceiveNotifications":{"type":"boolean"},"Lifetime":{"type":"boolean"},"PartnerCode":{"type":"string"},"ReasonText":{"type":"string"},"IdAffiliate":{"type":"integer"},"CustomerReference":{"type":"string"},"ExternalCustomerReference":{"type":"string"},"TestSubscription":{"type":"boolean"},"IsTrial":{"type":"boolean"},"Status":{"type":"string"},"LatestSubscriptionOrder":{"$ref":"#/components/schemas/LatestSubscriptionOrder"},"IsAssistedSale":{"type":"boolean"},"Billing":{"type":"object","properties":{"Quantity":{"type":"integer"},"Currency":{"type":"string"},"UnitBillingPriceNet":{"type":"number"},"UnitBillingPriceGross":{"type":"number"},"BillingPriceNet":{"type":"number"},"BillingPriceGross":{"type":"number"},"NoOfBillingCycles":{"type":"integer"},"CurrentBillingCycle":{"type":"integer"},"PayedBillingCycles":{"type":"integer"},"RemainingBillingCycles":{"type":"integer"},"CurrentBillingCycleEndDate":{"type":"string"},"TaxAmount":{"type":"number"},"TaxPercent":{"type":"number"},"BillingCyclesFrequency":{"type":"integer"},"BillingCycleFrequencyUnit":{"type":"string"},"ContractLength":{"type":"string","nullable":true},"ContractLengthUnit":{"type":"string"},"PriceOptions":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string"}}}}}}},"ActivationKey":{"type":"string","nullable":true}}}},"required":["NextBillingDate"]},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}},"EndUser":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Zip":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Language":{"type":"string"}}},"DeliveryInfo":{"type":"object","properties":{"Description":{"type":"string"},"Codes":{"$ref":"#/components/schemas/DeliveryInfo_Codes"}}},"DeliveryInfo_Codes":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInfoCode"}},"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}},"LatestSubscriptionOrder":{"type":"object","properties":{"RefNo":{"type":"integer"},"Status":{"type":"string"},"FailedRecurringChargesCount":{"type":"integer"}}}}}} ``` ## The EndUser object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"EndUser":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Zip":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Language":{"type":"string"}}}}}} ``` ## The DeliveryInfo object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryInfo":{"type":"object","properties":{"Description":{"type":"string"},"Codes":{"$ref":"#/components/schemas/DeliveryInfo_Codes"}}},"DeliveryInfo_Codes":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInfoCode"}},"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}}}}} ``` ## The DeliveryInfoCode object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}}}}} ``` ## The LatestSubscriptionOrder object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LatestSubscriptionOrder":{"type":"object","properties":{"RefNo":{"type":"integer"},"Status":{"type":"string"},"FailedRecurringChargesCount":{"type":"integer"}}}}}} ``` ## The ProductSkuSearchResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductSkuSearchResponse":{"type":"object","properties":{"ProductCode":{"type":"string"},"PricingConfigurations":{"$ref":"#/components/schemas/ProductSkuSearchResponse_PricingConfigurations"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"ProductSkuSearchResponse_PricingConfigurations":{"type":"object","properties":{"Code":{"type":"string"},"Currencies":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"PurchaseTypes":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseType"}},"QuantityIntervals":{"type":"array","items":{"$ref":"#/components/schemas/QuantityInterval"}},"PriceOptionGroups":{"type":"array","items":{"$ref":"#/components/schemas/PriceOptionGroup"}},"SkuCollection":{"type":"array","items":{"$ref":"#/components/schemas/Sku"}}}},"Currency":{"type":"object","properties":{"Code":{"type":"string"}}},"PurchaseType":{"type":"object","properties":{"Code":{"type":"string"}}},"QuantityInterval":{"type":"object","properties":{"MinQuantity":{"type":"number"},"MaxQuantity":{"type":"number"}}},"PriceOptionGroup":{"type":"object","properties":{"Code":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PriceOption"}}}},"PriceOption":{"type":"object","properties":{"OptionValue":{"type":"string"}}},"Sku":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptions"}}}},"SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetails"}}}},"SkuPricingOptionsDetails":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"number"},"ToQty":{"type":"number"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsDetails_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}},"Error":{"type":"object","properties":{"Field":{"type":"string"},"Message":{"type":"string"}}}}}} ``` ## The Currency object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Currency":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The PurchaseType object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PurchaseType":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The QuantityInterval object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"QuantityInterval":{"type":"object","properties":{"MinQuantity":{"type":"number"},"MaxQuantity":{"type":"number"}}}}}} ``` ## The PriceOptionGroup object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PriceOptionGroup":{"type":"object","properties":{"Code":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PriceOption"}}}},"PriceOption":{"type":"object","properties":{"OptionValue":{"type":"string"}}}}}} ``` ## The PriceOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PriceOption":{"type":"object","properties":{"OptionValue":{"type":"string"}}}}}} ``` ## The Sku object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Sku":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptions"}}}},"SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetails"}}}},"SkuPricingOptionsDetails":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"number"},"ToQty":{"type":"number"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsDetails_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The Error object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Error":{"type":"object","properties":{"Field":{"type":"string"},"Message":{"type":"string"}}}}}} ``` ## The SearchAffiliatesError object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchAffiliatesError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The SkuPricingOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetails"}}}},"SkuPricingOptionsDetails":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"number"},"ToQty":{"type":"number"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsDetails_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsDetails":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"number"},"ToQty":{"type":"number"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsDetails_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsDetailsOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsDetailsForSchema object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsDetailsForSchema":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsForSchema_Details"},"Errors":{"type":"array","items":{"type":"string"}}}},"SkuPricingOptionsDetailsForSchema_Details":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"},"1":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"}}},"SkuPricingOptionsForSchema":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"integer"},"ToQty":{"type":"integer"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsForSchema object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsForSchema":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"integer"},"ToQty":{"type":"integer"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The ValidationErrorsSkuPricingOptionsDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ValidationErrorsSkuPricingOptionsDetails":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"$ref":"#/components/schemas/ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions"}}},"ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"object","nullable":true},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The AffiliateResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AffiliateResponse":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"Status":{"type":"string"},"Affiliate Name":{"type":"string"},"Website":{"type":"string"},"CommissionList":{"$ref":"#/components/schemas/AffiliateResponse_CommissionList"},"RequestDate":{"type":"string"},"Categories":{"type":"array","items":{"type":"string"}},"TCStatus":{"type":"string"},"AffiliateContact":{"$ref":"#/components/schemas/AffiliateResponse_AffiliateContact"}}},"AffiliateResponse_CommissionList":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/CommissionList"}}},"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}},"AffiliateResponse_AffiliateContact":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/AffiliateContact"}}},"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The CommissionList object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}}}}} ``` ## The AffiliateContact object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The GetAdditionalFieldsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetAdditionalFieldsResponse":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalFieldsResponseItems"}},"AdditionalFieldsResponseItems":{"type":"object","properties":{"Label":{"type":"string"},"Code":{"type":"string"},"Type":{"type":"string"},"ApplyTo":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"ValidationRule":{"type":"string"},"Translations":{"$ref":"#/components/schemas/AdditionalFieldsResponseItems_Translations"},"Display":{"$ref":"#/components/schemas/AdditionalFieldsResponseItems_Display"}}},"AdditionalFieldsResponseItems_Translations":{"type":"object","properties":{"en":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"},"fr":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"}}},"AdditionalFieldsTranslations":{"type":"object","properties":{"Label":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"Language":{"type":"string"}}},"AdditionalFieldsResponseItems_Display":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"},"1":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"}}},"AdditionalFieldsDisplay":{"type":"object","properties":{"Type":{"type":"string"},"Active":{"type":"boolean"},"Required":{"type":"boolean"}}}}}} ``` ## The AdditionalFieldsResponseItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFieldsResponseItems":{"type":"object","properties":{"Label":{"type":"string"},"Code":{"type":"string"},"Type":{"type":"string"},"ApplyTo":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"ValidationRule":{"type":"string"},"Translations":{"$ref":"#/components/schemas/AdditionalFieldsResponseItems_Translations"},"Display":{"$ref":"#/components/schemas/AdditionalFieldsResponseItems_Display"}}},"AdditionalFieldsResponseItems_Translations":{"type":"object","properties":{"en":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"},"fr":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"}}},"AdditionalFieldsTranslations":{"type":"object","properties":{"Label":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"Language":{"type":"string"}}},"AdditionalFieldsResponseItems_Display":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"},"1":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"}}},"AdditionalFieldsDisplay":{"type":"object","properties":{"Type":{"type":"string"},"Active":{"type":"boolean"},"Required":{"type":"boolean"}}}}}} ``` ## The AdditionalFieldsTranslations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFieldsTranslations":{"type":"object","properties":{"Label":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"Language":{"type":"string"}}}}}} ``` ## The AdditionalFieldsDisplay object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFieldsDisplay":{"type":"object","properties":{"Type":{"type":"string"},"Active":{"type":"boolean"},"Required":{"type":"boolean"}}}}}} ``` ## The CustomerInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CustomerInformation":{"type":"object","properties":{"ExternalCustomerReference":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"Email":{"type":"string"},"ExistingCards":{"type":"array","items":{"type":"string"}},"Enabled":{"type":"boolean"},"Trial":{"type":"boolean"},"Language":{"type":"string"},"CustomerReference":{"type":"string"},"Credit":{"type":"object","properties":{"Limit":{"type":"number","description":"The credit limit available for customer","format":"float"},"Remaining":{"type":"number","description":"The remaining credit available for customer","format":"float"},"Currency":{"type":"string","description":"The credit currency"}}}}}}}} ``` ## The PromotionCoupon object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}}}}} ``` ## The PromotionDiscount object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}}}}} ``` ## The PromotionDiscountFixed object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}}}}} ``` ## The PromotionDiscountPercent object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}}}}} ``` ## The PromotionDiscountAmount object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}}}}} ``` ## The PromotionPriceThreshold object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}}}}} ``` ## The GlobalPromotionPriceThreshold object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}}}}} ``` ## The PromotionProduct object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PromotionProducts object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PromotionTranslation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}}}}} ``` ## The PromotionTranslations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}}}}} ``` ## The PromotionSources object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionSources":{"type":"object","properties":{"SOURCE_1":{"type":"string"},"SOURCE_2":{"type":"string"},"SOURCE_3":{"type":"string"}}}}}} ``` ## The priceMatrixPrice object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The PromotionResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"type":"array","items":{"type":"string"}}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}}}}} ``` ## The GlobalPromotionResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GlobalPromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}}}}} ``` ## The SpecialPricePromotionResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SpecialPricePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The CumulativePromotionResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CumulativePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The GetPromotionsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPromotionsResponse":{"type":"object","properties":{"Items":{"$ref":"#/components/schemas/PromotionResponse"},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"type":"array","items":{"type":"string"}}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The GetProductPriceMatrixResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetProductPriceMatrixResponse":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The SearchSkuPricingConfigurations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchSkuPricingConfigurations":{"type":"object","properties":{"Code":{"type":"string"},"Currencies":{"$ref":"#/components/schemas/Currency"}}},"Currency":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The SearchSkuPurchaseTypes object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchSkuPurchaseTypes":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The MarkLeadsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"MarkLeadsResponse":{"type":"object","properties":{"Response":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/MarkLeadsResponse_Errors"}}}},"MarkLeadsResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The ProposalBillToDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"}}}} ``` ## The PropProposalId object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"}}}} ``` ## The ProposalContent object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"}}}} ``` ## The Proposal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."}}}} ``` ## The ProposalCreateRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalCreateRequest":{"title":"Proposal Create Request","type":"object","description":"Proposal create request","properties":{"Name":{"$ref":"#/components/schemas/PropProposalName"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToCreate"},"Content":{"$ref":"#/components/schemas/ProposalContentCreate"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Tac":{"$ref":"#/components/schemas/ProposalCreateRequest_Tac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"Source":{"type":"string","description":"The source from where the proposal was created"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToCreate"},"Scope":{"$ref":"#/components/schemas/PropProposalScope"}},"required":["Type","Source"]},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalBillToCreate":{"title":"BillTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address","default":""},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalContentCreate":{"title":"ProposalContent create","required":["Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"ProposalCreateRequest_Tac":{"required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSellToCreate":{"title":"SellTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number for USA"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service"},"PropProposalScope":{"title":"ProposalScope","type":"string","description":"Amendment scope, send only for amendments. Use null to reset on update.","default":null,"nullable":true,"enum":["autorenewal"]}}}} ``` ## The ProposalLineItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]}}}} ``` ## The ProposalLineItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]}}}} ``` ## The PropProposalUserId object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"}}}} ``` ## The PropProposalName object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"}}}} ``` ## The ProposalUpdateRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalUpdateRequest":{"title":"Proposal Update Request","type":"object","description":"Proposal update request","properties":{"Name":{"$ref":"#/components/schemas/PropProposalName"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToOptional"},"Content":{"$ref":"#/components/schemas/ProposalContentOptional"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Tac":{"$ref":"#/components/schemas/ProposalTacOptional"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToOptional"},"Scope":{"$ref":"#/components/schemas/PropProposalScope"}}},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalBillToOptional":{"title":"BillTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalContentOptional":{"title":"ProposalContent optional","type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"type":"integer","description":"Net X terms in days","nullable":true},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalTacOptional":{"title":"tac","type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"ProposalSellToOptional":{"title":"SellTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"Used for tax calculation. Represents the entity using the service."},"PropProposalScope":{"title":"ProposalScope","type":"string","description":"Amendment scope, send only for amendments. Use null to reset on update.","default":null,"nullable":true,"enum":["autorenewal"]}}}} ``` ## The PropProposalLocked object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"}}}} ``` ## The PropProposalTacContent object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"}}}} ``` ## The ProposalTac object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"}}}} ``` ## The PropProposalType object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]}}}} ``` ## The PropProposalScope object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalScope":{"title":"ProposalScope","type":"string","description":"Amendment scope, send only for amendments. Use null to reset on update.","default":null,"nullable":true,"enum":["autorenewal"]}}}} ``` ## The ProposalBillToOptional object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalBillToOptional":{"title":"BillTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"The entity paying for the service and who is getting the invoice"}}}} ``` ## The ProposalTacOptional object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalTacOptional":{"title":"tac","type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"}}}} ``` ## The ProposalContentOptional object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalContentOptional":{"title":"ProposalContent optional","type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"type":"integer","description":"Net X terms in days","nullable":true},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]}}}} ``` ## The ProposalBillToCreate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalBillToCreate":{"title":"BillTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address","default":""},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"}}}} ``` ## The ProposalSentBy object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"}}}} ``` ## The PropProposalStatus object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]}}}} ``` ## The PropProposalExpirationDate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"}}}} ``` ## The ProposalLinks object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]}}}} ``` ## The PropProposalStatusComment object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"}}}} ``` ## The ProposalActionRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalActionRequest":{"title":"Proposal Action Request","required":["Action"],"type":"object","properties":{"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Action":{"type":"string","enum":["decline","accept","discard","reopen","send","close","preview","feedback"],"description":"The action to perform. For feedback, the statusComment parameter is mandatory to be provided. For send, the expirationDate and sentBy parameters are mandatory to be provided. For send, reopen and discard it is recommended to provide the userId parameter. For decline is recommended to provide the statusComment parameter."},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"content":{"$ref":"#/components/schemas/ActionRequestContent"},"SendEmail":{"type":"boolean","description":"used to skip sending notification email when set to false on sending or accepting a proposal","default":true}},"description":"Proposal action request"},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ActionRequestContent":{"title":"action_proposal_content","type":"object","description":"The content configuration proposed by the client on accepting the proposal","properties":{"lineItems":{"$ref":"#/components/schemas/ActionRequestLineItems"}}},"ActionRequestLineItems":{"title":"action_request_line_items","type":"array","description":"The line items configuration proposed by the client","items":{"$ref":"#/components/schemas/ActionRequestLineItem"}},"ActionRequestLineItem":{"title":"action_request_line_item","type":"object","description":"The line item configuration proposed by the client","properties":{"productCode":{"$ref":"#/components/schemas/PropProductCode"},"clientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"}},"required":["productCode","clientDealAutoRenewal"]},"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The ProposalSellToDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."}}}} ``` ## The ProposalSellToCreate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalSellToCreate":{"title":"SellTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number for USA"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service"}}}} ``` ## The ProposalSellToOptional object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalSellToOptional":{"title":"SellTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"Used for tax calculation. Represents the entity using the service."}}}} ``` ## The ProposalLink object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]}}}} ``` ## The ProposalAdditionalField object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"}}}} ``` ## The ProposalPriceOption object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"}}}} ``` ## The ProposalLineItemReturn object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"}}}} ``` ## The ProposalLineItemsReturn object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"}}}} ``` ## The ProposalContentCreate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalContentCreate":{"title":"ProposalContent create","required":["Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]}}}} ``` ## The ActionRequestContent object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ActionRequestContent":{"title":"action_proposal_content","type":"object","description":"The content configuration proposed by the client on accepting the proposal","properties":{"lineItems":{"$ref":"#/components/schemas/ActionRequestLineItems"}}},"ActionRequestLineItems":{"title":"action_request_line_items","type":"array","description":"The line items configuration proposed by the client","items":{"$ref":"#/components/schemas/ActionRequestLineItem"}},"ActionRequestLineItem":{"title":"action_request_line_item","type":"object","description":"The line item configuration proposed by the client","properties":{"productCode":{"$ref":"#/components/schemas/PropProductCode"},"clientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"}},"required":["productCode","clientDealAutoRenewal"]},"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The ActionRequestLineItems object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ActionRequestLineItems":{"title":"action_request_line_items","type":"array","description":"The line items configuration proposed by the client","items":{"$ref":"#/components/schemas/ActionRequestLineItem"}},"ActionRequestLineItem":{"title":"action_request_line_item","type":"object","description":"The line item configuration proposed by the client","properties":{"productCode":{"$ref":"#/components/schemas/PropProductCode"},"clientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"}},"required":["productCode","clientDealAutoRenewal"]},"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The ActionRequestLineItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ActionRequestLineItem":{"title":"action_request_line_item","type":"object","description":"The line item configuration proposed by the client","properties":{"productCode":{"$ref":"#/components/schemas/PropProductCode"},"clientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"}},"required":["productCode","clientDealAutoRenewal"]},"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The PropProductCode object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"}}}} ``` ## The PropClientDealAutoRenewal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The PropMerchantDealAutoRenewal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."}}}} ``` ## The PropClientAmendmentScenario object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]}}}} ``` ## The Usage object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Usage":{"required":["OptionCode","SubscriptionReference","Units","UsageEnd","UsageStart"],"type":"object","properties":{"UsageReference":{"type":"integer","description":"The unique usage identifier"},"SubscriptionReference":{"type":"string","description":"The subscription code"},"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}}}}} ``` ## The UsageSaveObject object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageSaveObject":{"required":["OptionCode","Units","UsageEnd","UsageStart"],"type":"object","properties":{"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}}}}} ``` ## The UsageDeleteRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageDeleteRequest":{"type":"object","properties":{"UsageReference":{"type":"integer","description":"Delete the usage entry with this unique UsageReference"},"OptionCode":{"type":"string","description":"Delete all usages with this price option group code"},"IntervalStart":{"type":"string","description":"Delete all usages with UsageEnd >= IntervalStart"},"IntervalEnd":{"type":"string","description":"Delete all usages with UsageEnd <= Intervalend"}}}}}} ``` ## The UsageDeleteClientErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageDeleteClientErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageDeleteServerErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageDeleteServerErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The FilteredUsagesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"FilteredUsagesResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Usage"}},"Pagination":{"$ref":"#/components/schemas/FilteredUsagesResponse_Pagination"}}},"Usage":{"required":["OptionCode","SubscriptionReference","Units","UsageEnd","UsageStart"],"type":"object","properties":{"UsageReference":{"type":"integer","description":"The unique usage identifier"},"SubscriptionReference":{"type":"string","description":"The subscription code"},"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}},"FilteredUsagesResponse_Pagination":{"type":"object","properties":{"Page":{"type":"integer","description":"Current page"},"Limit":{"type":"integer","description":"Max number of results per page"},"Count":{"type":"integer","description":"The total number of results"}}}}}} ``` ## The UsageFilterClientErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageFilterClientErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageFilterServerErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageFilterServerErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageSaveRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageSaveRequest":{"type":"array","items":{"$ref":"#/components/schemas/UsageSaveObject"}},"UsageSaveObject":{"required":["OptionCode","Units","UsageEnd","UsageStart"],"type":"object","properties":{"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}}}}} ``` ## The UsageSaveResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageSaveResponse":{"type":"array","items":{"$ref":"#/components/schemas/Usage"}},"Usage":{"required":["OptionCode","SubscriptionReference","Units","UsageEnd","UsageStart"],"type":"object","properties":{"UsageReference":{"type":"integer","description":"The unique usage identifier"},"SubscriptionReference":{"type":"string","description":"The subscription code"},"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}}}}} ``` ## The UsageSaveClientErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageSaveClientErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageNotFoundErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageNotFoundErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageSaveServerErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageSaveServerErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageUpdateRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageUpdateRequest":{"type":"object","properties":{"Units":{"type":"integer","description":"The new units to be updated on the subscription usage."},"Description":{"type":"string","description":"The new description to be updated on the subscription usage."}}}}}} ``` ## The UsageUpdateResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageUpdateResponse":{"$ref":"#/components/schemas/Usage"},"Usage":{"required":["OptionCode","SubscriptionReference","Units","UsageEnd","UsageStart"],"type":"object","properties":{"UsageReference":{"type":"integer","description":"The unique usage identifier"},"SubscriptionReference":{"type":"string","description":"The subscription code"},"OptionCode":{"type":"string","description":"The price option group code"},"UsageStart":{"type":"string","description":"The date the usage came in effect."},"UsageEnd":{"type":"string","description":"The date the usage was stopped being used."},"Units":{"type":"integer","format":"int32"},"Description":{"type":"string"}}}}}} ``` ## The UsageUpdateClientErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageUpdateClientErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The UsageUpdateServerErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UsageUpdateServerErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The ChangeDealRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ChangeDealRequest":{"type":"object","properties":{"Currency":{"type":"string","description":"The deal order currency code"},"Country":{"type":"string","description":"The deal order country code"},"Language":{"type":"string","description":"The deal order language code"},"CustomerIp":{"type":"string","description":"The deal order customer IP"},"Source":{"type":"string","description":"The deal order source"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/DealRequestItem"},"description":"The deal order items"},"BillingDetails":{"$ref":"#/components/schemas/BillingDetails"},"DeliveryDetails":{"$ref":"#/components/schemas/DeliveryDetails"},"PaymentDetails":{"$ref":"#/components/schemas/PlaceOrder_PaymentDetails"},"ExtraInformation":{"$ref":"#/components/schemas/PlaceOrder_ExtraInformation"}}},"DealRequestItem":{"type":"object","properties":{"DealDate":{"type":"string","description":"The date and time when the deal will be operated"},"SubscriptionReference":{"type":"string","description":"The deal license code"},"ProductCode":{"type":"string","description":"The deal license product code"},"Quantity":{"type":"integer","description":"The deal license product quantity"},"DealPriceScenario":{"type":"string","description":"The deal price calculation scenario","enum":["using_last_order_price","using_last_product_price","price_total","product_price_difference"]},"DealSubscriptionScenario":{"type":"string","description":"The license upgrade scenario","enum":["prolong","does_not_affect","start_new_deal_contract_now","start_new_deal_contract_after_current_cycle"]},"Price":{"type":"object","description":"The deal item custom price details","properties":{"Amount":{"type":"number","description":"The price amount value"},"Type":{"type":"string","description":"the price type (use CUSTOM in this case)"},"AmountType":{"type":"string","description":"the price amount type (GROSS or NET)"}}},"SubscriptionCustomSettings":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"},"PriceOptions":{"$ref":"#/components/schemas/DealItemPriceOptions"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}},"BillingDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"PlaceOrder_PaymentDetails":{"required":["Currency","Type"],"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string","description":"The currency ISO code for the payment - ISO 4217. Can be changed for the method \"Place an order with manual renewal\" to set a common currency for multiple subscriptions renewed via the same order."},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/PlaceOrder_PaymentDetails_PaymentMethod"}}},"PlaceOrder_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardNumber":{"type":"string"},"CardType":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"},"ExpirationYear":{"type":"string"},"ExpirationMonth":{"type":"string"},"CCID":{"type":"string"},"HolderName":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"HolderNameTime":{"type":"integer"},"CardNumberTime":{"type":"integer"}}},"PlaceOrder_ExtraInformation":{"type":"object","properties":{"RetryFailedPaymentLink":{"type":"string","format":"url","description":"One of the url query params must be \"[REFNO]\""},"ProposalId":{"type":"string","maximum":36},"PurchaseOrderDownloadLink":{"type":"string","format":"url"},"AssistedSale":{"type":"boolean"},"AssistedSaleAccountManagerEmail":{"type":"string"}}}}}} ``` ## The DealRequestItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealRequestItem":{"type":"object","properties":{"DealDate":{"type":"string","description":"The date and time when the deal will be operated"},"SubscriptionReference":{"type":"string","description":"The deal license code"},"ProductCode":{"type":"string","description":"The deal license product code"},"Quantity":{"type":"integer","description":"The deal license product quantity"},"DealPriceScenario":{"type":"string","description":"The deal price calculation scenario","enum":["using_last_order_price","using_last_product_price","price_total","product_price_difference"]},"DealSubscriptionScenario":{"type":"string","description":"The license upgrade scenario","enum":["prolong","does_not_affect","start_new_deal_contract_now","start_new_deal_contract_after_current_cycle"]},"Price":{"type":"object","description":"The deal item custom price details","properties":{"Amount":{"type":"number","description":"The price amount value"},"Type":{"type":"string","description":"the price type (use CUSTOM in this case)"},"AmountType":{"type":"string","description":"the price amount type (GROSS or NET)"}}},"SubscriptionCustomSettings":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"},"PriceOptions":{"$ref":"#/components/schemas/DealItemPriceOptions"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}}}}} ``` ## The DealItemPriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}}}}} ``` ## The ChangeDealResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ChangeDealResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ChangeDealResponseItem"}},"Currency":{"type":"string"},"DealDueNowPriceNet":{"type":"number"},"DealDueNowPriceGross":{"type":"number"},"DealTaxAmount":{"type":"number"},"DealOrder":{"$ref":"#/components/schemas/DealOrder"}}},"ChangeDealResponseItem":{"type":"object","properties":{"SubscriptionReference":{"type":"string","description":"The deal license code"},"DealPriceScenario":{"type":"string","description":"The deal price calculation scenario","enum":["using_last_order_price","using_last_product_price","price_total","product_price_difference"]},"DealSubscriptionScenario":{"type":"string","description":"The license upgrade scenario","enum":["prolong","does_not_affect","start_new_deal_contract_now","start_new_deal_contract_after_current_cycle"]},"DealDate":{"type":"string","description":"The date and time when the deal will be operated"},"DealDueNowPriceNet":{"type":"number","description":"The deal net price due to the given deal date"},"DealDueNowPriceGross":{"type":"number","description":"The deal gross price due to the given deal date"},"DealTaxAmount":{"type":"number","description":"The deal tax amount"},"DealTaxPercent":{"type":"number","description":"The deal tax percent"},"CurrentInfo":{"$ref":"#/components/schemas/DealInfo"},"NewDealInfo":{"$ref":"#/components/schemas/DealInfo"},"TotalsDealInfo":{"$ref":"#/components/schemas/TotalsDealInfo"}}},"DealInfo":{"type":"object","properties":{"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"ProductDescription":{"type":"string"},"BillingPriceNet":{"type":"number"},"BillingPriceGross":{"type":"number"},"NoOfBillingCycles":{"type":"integer"},"CurrentBillingCycles":{"type":"integer"},"PayedBillingCycles":{"type":"integer"},"RemainingBillingCycles":{"type":"integer"},"CurrentBillingCycleEndDate":{"type":"string"},"TaxAmount":{"type":"number"},"TaxPercent":{"type":"number"},"BillingCyclesFrequency":{"type":"integer"},"BillingCyclesFrequencyUnit":{"type":"string"},"ContractLength":{"type":"integer"},"ContractLengthUnit":{"type":"string"},"ProductOptions":{"type":"array","items":{"$ref":"#/components/schemas/DealItemPriceOptions"}}}},"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}},"TotalsDealInfo":{"type":"object","properties":{"DealsNumber":{"type":"integer"},"ContractsNumber":{"type":"integer"},"PaidBillingCycles":{"type":"integer"},"ElapsedBillingCycles":{"type":"integer"}}},"DealOrder":{"allOf":[{"$ref":"#/components/schemas/body_1"},{"$ref":"#/components/schemas/DealDeliveryDetails"}]},"body_1":{"type":"object","properties":{"BillingDetails":{"$ref":"#/components/schemas/orders0_BillingDetails"},"Affiliate":{"$ref":"#/components/schemas/orders0_Affiliate"},"ExternalCustomerReference":{"type":"string"},"CustomerReference":{"type":"string"},"Country":{"type":"string"},"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/orders0_Items"}},"Language":{"type":"string"},"PaymentDetails":{"$ref":"#/components/schemas/orders0_PaymentDetails"},"Source":{"type":"string"}}},"orders0_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"FiscalCode":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}},"orders0_Affiliate":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"AffiliateSource":{"type":"string"}}},"orders0_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"CrossSell":{"$ref":"#/components/schemas/orders0_CrossSellCampaign"},"SubscriptionCustomSetting":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"}}},"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"orders0_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/orders0_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"orders0_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardNumberTime":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"},"HolderNameTime":{"type":"string"},"RecurringEnabled":{"type":"boolean"}}},"DealDeliveryDetails":{"type":"object","properties":{"DeliveryDetails":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The ChangeDealResponseItem object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ChangeDealResponseItem":{"type":"object","properties":{"SubscriptionReference":{"type":"string","description":"The deal license code"},"DealPriceScenario":{"type":"string","description":"The deal price calculation scenario","enum":["using_last_order_price","using_last_product_price","price_total","product_price_difference"]},"DealSubscriptionScenario":{"type":"string","description":"The license upgrade scenario","enum":["prolong","does_not_affect","start_new_deal_contract_now","start_new_deal_contract_after_current_cycle"]},"DealDate":{"type":"string","description":"The date and time when the deal will be operated"},"DealDueNowPriceNet":{"type":"number","description":"The deal net price due to the given deal date"},"DealDueNowPriceGross":{"type":"number","description":"The deal gross price due to the given deal date"},"DealTaxAmount":{"type":"number","description":"The deal tax amount"},"DealTaxPercent":{"type":"number","description":"The deal tax percent"},"CurrentInfo":{"$ref":"#/components/schemas/DealInfo"},"NewDealInfo":{"$ref":"#/components/schemas/DealInfo"},"TotalsDealInfo":{"$ref":"#/components/schemas/TotalsDealInfo"}}},"DealInfo":{"type":"object","properties":{"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"ProductDescription":{"type":"string"},"BillingPriceNet":{"type":"number"},"BillingPriceGross":{"type":"number"},"NoOfBillingCycles":{"type":"integer"},"CurrentBillingCycles":{"type":"integer"},"PayedBillingCycles":{"type":"integer"},"RemainingBillingCycles":{"type":"integer"},"CurrentBillingCycleEndDate":{"type":"string"},"TaxAmount":{"type":"number"},"TaxPercent":{"type":"number"},"BillingCyclesFrequency":{"type":"integer"},"BillingCyclesFrequencyUnit":{"type":"string"},"ContractLength":{"type":"integer"},"ContractLengthUnit":{"type":"string"},"ProductOptions":{"type":"array","items":{"$ref":"#/components/schemas/DealItemPriceOptions"}}}},"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}},"TotalsDealInfo":{"type":"object","properties":{"DealsNumber":{"type":"integer"},"ContractsNumber":{"type":"integer"},"PaidBillingCycles":{"type":"integer"},"ElapsedBillingCycles":{"type":"integer"}}}}}} ``` ## The DealInfo object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealInfo":{"type":"object","properties":{"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"ProductDescription":{"type":"string"},"BillingPriceNet":{"type":"number"},"BillingPriceGross":{"type":"number"},"NoOfBillingCycles":{"type":"integer"},"CurrentBillingCycles":{"type":"integer"},"PayedBillingCycles":{"type":"integer"},"RemainingBillingCycles":{"type":"integer"},"CurrentBillingCycleEndDate":{"type":"string"},"TaxAmount":{"type":"number"},"TaxPercent":{"type":"number"},"BillingCyclesFrequency":{"type":"integer"},"BillingCyclesFrequencyUnit":{"type":"string"},"ContractLength":{"type":"integer"},"ContractLengthUnit":{"type":"string"},"ProductOptions":{"type":"array","items":{"$ref":"#/components/schemas/DealItemPriceOptions"}}}},"DealItemPriceOptions":{"type":"object","description":"item price options","properties":{"Code":{"type":"string","description":"price option group code"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"priceo option code or value"}}}}}}}}} ``` ## The TotalsDealInfo object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"TotalsDealInfo":{"type":"object","properties":{"DealsNumber":{"type":"integer"},"ContractsNumber":{"type":"integer"},"PaidBillingCycles":{"type":"integer"},"ElapsedBillingCycles":{"type":"integer"}}}}}} ``` ## The DealOrder object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealOrder":{"allOf":[{"$ref":"#/components/schemas/body_1"},{"$ref":"#/components/schemas/DealDeliveryDetails"}]},"body_1":{"type":"object","properties":{"BillingDetails":{"$ref":"#/components/schemas/orders0_BillingDetails"},"Affiliate":{"$ref":"#/components/schemas/orders0_Affiliate"},"ExternalCustomerReference":{"type":"string"},"CustomerReference":{"type":"string"},"Country":{"type":"string"},"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/orders0_Items"}},"Language":{"type":"string"},"PaymentDetails":{"$ref":"#/components/schemas/orders0_PaymentDetails"},"Source":{"type":"string"}}},"orders0_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"FiscalCode":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}},"orders0_Affiliate":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"AffiliateSource":{"type":"string"}}},"orders0_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"CrossSell":{"$ref":"#/components/schemas/orders0_CrossSellCampaign"},"SubscriptionCustomSetting":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"}}},"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"orders0_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/orders0_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"orders0_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardNumberTime":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"},"HolderNameTime":{"type":"string"},"RecurringEnabled":{"type":"boolean"}}},"DealDeliveryDetails":{"type":"object","properties":{"DeliveryDetails":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The DealDeliveryDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealDeliveryDetails":{"type":"object","properties":{"DeliveryDetails":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The DealErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DealErrorResponse":{"type":"object","properties":{"error_code":{"type":"string","description":"Error type code"},"message":{"type":"string","description":"Error message"}}}}}} ``` ## The inline\_response\_200 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"$ref":"#/components/schemas/inline_response_200_SkuPricingOptions"}}},"inline_response_200_SkuPricingOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsForSchema"},"1":{"$ref":"#/components/schemas/ValidationErrorsSkuPricingOptionsDetails"}}},"SkuPricingOptionsDetailsForSchema":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsForSchema_Details"},"Errors":{"type":"array","items":{"type":"string"}}}},"SkuPricingOptionsDetailsForSchema_Details":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"},"1":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"}}},"SkuPricingOptionsForSchema":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"integer"},"ToQty":{"type":"integer"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}},"ValidationErrorsSkuPricingOptionsDetails":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"$ref":"#/components/schemas/ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions"}}},"ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"object","nullable":true},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The inline\_response\_401 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_401":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The inline\_response\_401\_1 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_401_1":{"properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_1 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_1":{"properties":{"Affiliate":{"$ref":"#/components/schemas/AffiliateResponse"}}},"AffiliateResponse":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"Status":{"type":"string"},"Affiliate Name":{"type":"string"},"Website":{"type":"string"},"CommissionList":{"$ref":"#/components/schemas/AffiliateResponse_CommissionList"},"RequestDate":{"type":"string"},"Categories":{"type":"array","items":{"type":"string"}},"TCStatus":{"type":"string"},"AffiliateContact":{"$ref":"#/components/schemas/AffiliateResponse_AffiliateContact"}}},"AffiliateResponse_CommissionList":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/CommissionList"}}},"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}},"AffiliateResponse_AffiliateContact":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/AffiliateContact"}}},"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_2 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_2":{"properties":{"Affiliates":{"$ref":"#/components/schemas/inline_response_200_2_Affiliates"},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"inline_response_200_2_Affiliates":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AffiliateResponse"},"1":{"$ref":"#/components/schemas/AffiliateResponse"}}},"AffiliateResponse":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"Status":{"type":"string"},"Affiliate Name":{"type":"string"},"Website":{"type":"string"},"CommissionList":{"$ref":"#/components/schemas/AffiliateResponse_CommissionList"},"RequestDate":{"type":"string"},"Categories":{"type":"array","items":{"type":"string"}},"TCStatus":{"type":"string"},"AffiliateContact":{"$ref":"#/components/schemas/AffiliateResponse_AffiliateContact"}}},"AffiliateResponse_CommissionList":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/CommissionList"}}},"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}},"AffiliateResponse_AffiliateContact":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/AffiliateContact"}}},"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The additionalfields\_Translations\_de object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"additionalfields_Translations_de":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The additionalfields\_Translations\_fr object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"additionalfields_Translations_fr":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The additionalfields\_Translations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"additionalfields_Translations":{"type":"object","properties":{"de":{"$ref":"#/components/schemas/additionalfields_Translations_de"},"fr":{"$ref":"#/components/schemas/additionalfields_Translations_fr"}}},"additionalfields_Translations_de":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}},"additionalfields_Translations_fr":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The body object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body":{"properties":{"ApplyTo":{"type":"string"},"Code":{"type":"string"},"Label":{"type":"string"},"Translations":{"$ref":"#/components/schemas/additionalfields_Translations"},"Type":{"type":"string"},"ValidationRule":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}},"additionalfields_Translations":{"type":"object","properties":{"de":{"$ref":"#/components/schemas/additionalfields_Translations_de"},"fr":{"$ref":"#/components/schemas/additionalfields_Translations_fr"}}},"additionalfields_Translations_de":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}},"additionalfields_Translations_fr":{"type":"object","properties":{"Label":{"type":"string"},"Language":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The inline\_response\_400 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_400":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The inline\_response\_404 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_404":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_3 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_3":{"properties":{"Label":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"Language":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_4 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_4":{"properties":{"filename":{"type":"string"},"data":{"type":"string"}}}}}} ``` ## The orders0\_BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"FiscalCode":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}}}}} ``` ## The orders0\_Affiliate object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_Affiliate":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"AffiliateSource":{"type":"string"}}}}}} ``` ## The orders0\_Items object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"CrossSell":{"$ref":"#/components/schemas/orders0_CrossSellCampaign"},"SubscriptionCustomSetting":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"}}},"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}}}}} ``` ## The orders0\_CrossSellCampaign object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}}}}} ``` ## The orders0\_PaymentDetails\_PaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardNumberTime":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"},"HolderNameTime":{"type":"string"},"RecurringEnabled":{"type":"boolean"}}}}}} ``` ## The orders0\_PaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/orders0_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"orders0_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardNumberTime":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"},"HolderNameTime":{"type":"string"},"RecurringEnabled":{"type":"boolean"}}}}}} ``` ## The body\_1 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_1":{"type":"object","properties":{"BillingDetails":{"$ref":"#/components/schemas/orders0_BillingDetails"},"Affiliate":{"$ref":"#/components/schemas/orders0_Affiliate"},"ExternalCustomerReference":{"type":"string"},"CustomerReference":{"type":"string"},"Country":{"type":"string"},"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/orders0_Items"}},"Language":{"type":"string"},"PaymentDetails":{"$ref":"#/components/schemas/orders0_PaymentDetails"},"Source":{"type":"string"}}},"orders0_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"FiscalCode":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}},"orders0_Affiliate":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"AffiliateSource":{"type":"string"}}},"orders0_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"CrossSell":{"$ref":"#/components/schemas/orders0_CrossSellCampaign"},"SubscriptionCustomSetting":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"}}},"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"orders0_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/orders0_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"orders0_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardNumberTime":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"},"HolderNameTime":{"type":"string"},"RecurringEnabled":{"type":"boolean"}}}}}} ``` ## The orders0shipping\_BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0shipping_BillingDetails":{"type":"object","properties":{"CountryCode":{"type":"string"}}}}}} ``` ## The orders0shipping\_Items object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"orders0shipping_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"number"}}}}}} ``` ## The body\_2 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_2":{"type":"object","properties":{"BillingDetails":{"$ref":"#/components/schemas/orders0shipping_BillingDetails"},"CouponCodes":{"type":"array","items":{"nullable":true}},"Currency":{"type":"string"},"DeliveryDetails":{"$ref":"#/components/schemas/orders0shipping_BillingDetails"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/orders0shipping_Items"}}}},"orders0shipping_BillingDetails":{"type":"object","properties":{"CountryCode":{"type":"string"}}},"orders0shipping_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"number"}}}}}} ``` ## The body\_3 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_3":{"type":"object","properties":{"amount":{"type":"number"},"items":{"type":"array","items":{"$ref":"#/components/schemas/orders0shipping_Items"}},"comment":{"type":"string"},"reason":{"type":"string"}}},"orders0shipping_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"number"}}}}}} ``` ## The ordersUpload object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ordersUpload":{"type":"object","properties":{"FileName":{"type":"string"},"ClientTime":{"type":"string"},"File":{"type":"string"}}}}}} ``` ## The applePaySession200 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"applePaySession200":{"type":"object","properties":{"ApplePaySessionData":{"type":"object","properties":{"response":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}} ``` ## The applePaySession400 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"applePaySession400":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The decryptApplePayData200 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"decryptApplePayData200":{"type":"object","properties":{"ApplePayDataToken":{"type":"string"},"BillingDetails":{"type":"object"},"DeliveryDetails":{"type":"object"},"Status":{"type":"boolean"}}}}}} ``` ## The decryptApplePayData400 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"decryptApplePayData400":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The paymentmethodsPAYPAL\_EXPRESSredirecturl\_PaymentDetails\_PaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails_PaymentMethod":{"type":"object","properties":{"Email":{"type":"string"},"ReturnURL":{"type":"string"}}}}}} ``` ## The paymentmethodsPAYPAL\_EXPRESSredirecturl\_PaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails_PaymentMethod":{"type":"object","properties":{"Email":{"type":"string"},"ReturnURL":{"type":"string"}}}}}} ``` ## The body\_4 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_4":{"type":"object","properties":{"Country":{"type":"string"},"Currency":{"type":"string"},"CustomerIP":{"type":"string"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/orders0_Items"}},"Language":{"type":"string"},"PaymentDetails":{"$ref":"#/components/schemas/paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails"}}},"orders0_Items":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"CrossSell":{"$ref":"#/components/schemas/orders0_CrossSellCampaign"},"SubscriptionCustomSetting":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"}}},"orders0_CrossSellCampaign":{"required":["ParentCode","CampaignCode"],"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"string"}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails":{"type":"object","properties":{"Currency":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails_PaymentMethod"},"Type":{"type":"string"}}},"paymentmethodsPAYPAL_EXPRESSredirecturl_PaymentDetails_PaymentMethod":{"type":"object","properties":{"Email":{"type":"string"},"ReturnURL":{"type":"string"}}}}}} ``` ## The priceoptions\_PriceImpact\_Amounts\_AUD object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}}}}} ``` ## The priceoptions\_PriceImpact\_Amounts object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceoptions_PriceImpact_Amounts":{"type":"object","properties":{"AUD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"BRL":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"CAD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"EUR":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"GBP":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"JPY":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"USD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"}}},"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}}}}} ``` ## The priceoptions\_PriceImpact object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceoptions_PriceImpact":{"type":"object","properties":{"Amounts":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts"},"Impact":{"type":"string"},"ImpactOn":{"nullable":true},"Method":{"type":"string"},"Percent":{"nullable":true}}},"priceoptions_PriceImpact_Amounts":{"type":"object","properties":{"AUD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"BRL":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"CAD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"EUR":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"GBP":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"JPY":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"USD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"}}},"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}}}}} ``` ## The priceoptions\_Translations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceoptions_Translations":{"required":["Description","Language","Name"],"type":"object","properties":{"Description":{"type":"string","nullable":true},"Language":{"type":"string"},"Name":{"type":"string"}}}}}} ``` ## The priceoptions\_Options object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"priceoptions_Options":{"required":["Code","Default","Description","Name","PriceImpact","ScaleMax","ScaleMin","SubscriptionImpact","Translations"],"type":"object","properties":{"Code":{"type":"string"},"Default":{"type":"boolean"},"Description":{"type":"string"},"Name":{"type":"string"},"PriceImpact":{"$ref":"#/components/schemas/priceoptions_PriceImpact"},"ScaleMax":{"type":"string"},"ScaleMin":{"type":"string"},"SubscriptionImpact":{"nullable":true},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Translations"}}}},"priceoptions_PriceImpact":{"type":"object","properties":{"Amounts":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts"},"Impact":{"type":"string"},"ImpactOn":{"nullable":true},"Method":{"type":"string"},"Percent":{"nullable":true}}},"priceoptions_PriceImpact_Amounts":{"type":"object","properties":{"AUD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"BRL":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"CAD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"EUR":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"GBP":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"JPY":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"USD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"}}},"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"priceoptions_Translations":{"required":["Description","Language","Name"],"type":"object","properties":{"Description":{"type":"string","nullable":true},"Language":{"type":"string"},"Name":{"type":"string"}}}}}} ``` ## The CreatePriceOptionGroups object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreatePriceOptionGroups":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"},"Usage":{"type":"string","enum":["PAYPERUSAGE","REGULAR"]},"UsagePricingModel":{"type":"string","enum":["STEPPED","VOLUME"]},"Name":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Options"}},"Required":{"type":"boolean"},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Translations"}},"Type":{"type":"string"}}},"priceoptions_Options":{"required":["Code","Default","Description","Name","PriceImpact","ScaleMax","ScaleMin","SubscriptionImpact","Translations"],"type":"object","properties":{"Code":{"type":"string"},"Default":{"type":"boolean"},"Description":{"type":"string"},"Name":{"type":"string"},"PriceImpact":{"$ref":"#/components/schemas/priceoptions_PriceImpact"},"ScaleMax":{"type":"string"},"ScaleMin":{"type":"string"},"SubscriptionImpact":{"nullable":true},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Translations"}}}},"priceoptions_PriceImpact":{"type":"object","properties":{"Amounts":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts"},"Impact":{"type":"string"},"ImpactOn":{"nullable":true},"Method":{"type":"string"},"Percent":{"nullable":true}}},"priceoptions_PriceImpact_Amounts":{"type":"object","properties":{"AUD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"BRL":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"CAD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"EUR":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"GBP":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"JPY":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"USD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"}}},"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"priceoptions_Translations":{"required":["Description","Language","Name"],"type":"object","properties":{"Description":{"type":"string","nullable":true},"Language":{"type":"string"},"Name":{"type":"string"}}}}}} ``` ## The UpdatePriceOptionGroups object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdatePriceOptionGroups":{"type":"object","properties":{"Code":{"type":"string"},"Usage":{"type":"string","enum":["PAYPERUSAGE","REGULAR"]},"Description":{"type":"string"},"Name":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Options"}},"Required":{"type":"boolean"},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Translations"}},"Type":{"type":"string"}}},"priceoptions_Options":{"required":["Code","Default","Description","Name","PriceImpact","ScaleMax","ScaleMin","SubscriptionImpact","Translations"],"type":"object","properties":{"Code":{"type":"string"},"Default":{"type":"boolean"},"Description":{"type":"string"},"Name":{"type":"string"},"PriceImpact":{"$ref":"#/components/schemas/priceoptions_PriceImpact"},"ScaleMax":{"type":"string"},"ScaleMin":{"type":"string"},"SubscriptionImpact":{"nullable":true},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/priceoptions_Translations"}}}},"priceoptions_PriceImpact":{"type":"object","properties":{"Amounts":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts"},"Impact":{"type":"string"},"ImpactOn":{"nullable":true},"Method":{"type":"string"},"Percent":{"nullable":true}}},"priceoptions_PriceImpact_Amounts":{"type":"object","properties":{"AUD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"BRL":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"CAD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"EUR":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"GBP":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"JPY":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"},"USD":{"$ref":"#/components/schemas/priceoptions_PriceImpact_Amounts_AUD"}}},"priceoptions_PriceImpact_Amounts_AUD":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"priceoptions_Translations":{"required":["Description","Language","Name"],"type":"object","properties":{"Description":{"type":"string","nullable":true},"Language":{"type":"string"},"Name":{"type":"string"}}}}}} ``` ## The Product\_ProductGroup object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}}}}} ``` ## The products\_AdditionalFields object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}}}}} ``` ## The products\_FulfillmentInformation\_AdditionalInformationEmailTranslations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}}}}} ``` ## The products\_FulfillmentInformation\_BackupMedia object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}}}}} ``` ## The products\_FulfillmentInformation\_ProductFile object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The products\_FulfillmentInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The product\_getTaxCategoriesResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"product_getTaxCategoriesResponse":{"type":"array","items":{"$ref":"#/components/schemas/product_getTaxCategory"}},"product_getTaxCategory":{"type":"object","description":"The tax category to which the product belongs.","properties":{"ProductTaxCategoryUUID":{"type":"string","description":"The ID of the product tax category available."},"Name":{"type":"string","description":"The name of the product tax category available"}}}}}} ``` ## The product\_getTaxCategory object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"product_getTaxCategory":{"type":"object","description":"The tax category to which the product belongs.","properties":{"ProductTaxCategoryUUID":{"type":"string","description":"The ID of the product tax category available."},"Name":{"type":"string","description":"The name of the product tax category available"}}}}}} ``` ## The products\_Platforms object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}}}}} ``` ## The products\_PriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}}}}} ``` ## The products\_PricingConfigurations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}}}}} ``` ## The products\_ProductImages object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}}}}} ``` ## The products\_ShippingClass object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}}}}} ``` ## The products\_SubscriptionInformation\_ContractPeriod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}}}}} ``` ## The products\_SubscriptionInformation\_GracePeriod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}}}}} ``` ## The products\_SubscriptionInformation\_RenewalEmails\_Settings\_AutomaticRenewal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}}}}} ``` ## The products\_SubscriptionInformation\_RenewalEmails\_Settings object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}}}}} ``` ## The products\_SubscriptionInformation\_RenewalEmails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}}}}} ``` ## The products\_SubscriptionInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}}}}} ``` ## The products\_Translations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}}}}} ``` ## The Product\_TangibleDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}}}}} ``` ## The Product\_TangibleDetails\_HandlingFee object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}}}}} ``` ## The Product\_TangibleDetails\_UnitDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}}}}} ``` ## The ProductResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductResponse":{"allOf":[{"$ref":"#/components/schemas/Product"}]},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The CreateProductRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreateProductRequest":{"allOf":[{"$ref":"#/components/schemas/Product"}],"required":["ProductCode","ProductName","PricingConfigurations"]},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The UpdateProductRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdateProductRequest":{"allOf":[{"$ref":"#/components/schemas/Product"},{"type":"object","properties":{"GroupName":{"type":"string"}}}]},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The Product object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The Product\_PricingConfiguration\_Price object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}}}}} ``` ## The Product\_PricingConfiguration\_Prices object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Product_PricingConfiguration_Prices":{"type":"object","properties":{"Regular":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"Renewal":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}}}}} ``` ## The productsProductCodepricingconfigurations\_PriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"productsProductCodepricingconfigurations_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string"},"Required":{"type":"boolean"},"CustomImpactOnPrice":{"type":"boolean"}}}}}} ``` ## The body\_10 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_10":{"type":"object","properties":{"BillingCountries":{"type":"array","items":{}},"Default":{"type":"boolean"},"DefaultCurrency":{"type":"string"},"Name":{"type":"string"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/productsProductCodepricingconfigurations_PriceOptions"}},"PriceType":{"type":"string"},"Prices":{"$ref":"#/components/schemas/Product_PricingConfiguration_Prices"},"PricingSchema":{"type":"string"}}},"productsProductCodepricingconfigurations_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string"},"Required":{"type":"boolean"},"CustomImpactOnPrice":{"type":"boolean"}}},"Product_PricingConfiguration_Prices":{"type":"object","properties":{"Regular":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"Renewal":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}}}}} ``` ## The body\_11 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_11":{"type":"object","properties":{"BillingCountries":{"type":"array","items":{}},"UseOriginalPrices":{"type":"boolean"},"Code":{"type":"string"},"Default":{"type":"boolean"},"DefaultCurrency":{"type":"string"},"Name":{"type":"string"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/productsProductCodepricingconfigurations_PriceOptions"}},"PriceType":{"type":"string"},"Prices":{"$ref":"#/components/schemas/Product_PricingConfiguration_Prices"},"PricingSchema":{"type":"string"}}},"productsProductCodepricingconfigurations_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string"},"Required":{"type":"boolean"},"CustomImpactOnPrice":{"type":"boolean"}}},"Product_PricingConfiguration_Prices":{"type":"object","properties":{"Regular":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"Renewal":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}}}}} ``` ## The promotions\_Coupon object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}}}}} ``` ## The promotions\_Discount object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"promotions_Discount":{"type":"object","properties":{"Type":{"type":"string"},"Value":{"type":"number"}}}}}} ``` ## The promotions\_Products object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The RegularPromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"RegularPromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"ChannelType":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Discount":{"$ref":"#/components/schemas/promotions_Discount"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"PublishToAffiliatesNetwork":{"type":"number"},"StartDate":{"type":"string"},"Type":{"type":"string"}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"promotions_Discount":{"type":"object","properties":{"Type":{"type":"string"},"Value":{"type":"number"}}},"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The GlobalPromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GlobalPromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"ChannelType":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"PublishToAffiliatesNetwork":{"type":"number"},"StartDate":{"type":"string"},"Type":{"type":"string"}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}}}}} ``` ## The SpecialPricePromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SpecialPricePromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The CumulativePromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CumulativePromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}},"promotions_Products":{"type":"object","properties":{"Code":{"type":"string"}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"type":"string"},"OptionText":{"type":"string"}}}},"Prices":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"number"},"Currency":{"type":"string"}}}}}}}}} ``` ## The promotionsPromotionCode\_Coupon object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"promotionsPromotionCode_Coupon":{"type":"object","properties":{"Code":{"type":"string"},"Type":{"type":"string"}}}}}} ``` ## The promotionsPromotionCode\_Products object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"promotionsPromotionCode_Products":{"type":"object","properties":{"Id":{"type":"number"}}}}}} ``` ## The body\_13 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_13":{"type":"object","properties":{"ApplyRecurring":{"type":"number"},"ChannelType":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotionsPromotionCode_Coupon"},"Description":{"type":"string"},"Discount":{"$ref":"#/components/schemas/promotions_Discount"},"Enabled":{"type":"number"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotionsPromotionCode_Products"}},"PublishToAffiliatesNetwork":{"type":"number"},"RecurringChargesNumber":{"type":"number"},"Sources":{"type":"array","items":{"type":"string"}},"StartDate":{"type":"string"},"Translations":{"nullable":true},"Type":{"type":"string"}}},"promotionsPromotionCode_Coupon":{"type":"object","properties":{"Code":{"type":"string"},"Type":{"type":"string"}}},"promotions_Discount":{"type":"object","properties":{"Type":{"type":"string"},"Value":{"type":"number"}}},"promotionsPromotionCode_Products":{"type":"object","properties":{"Id":{"type":"number"}}}}}} ``` ## The body\_14 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_14":{"type":"object","properties":{"Code":{"type":"string"},"Type":{"type":"string"}}}}}} ``` ## The body\_15 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_15":{"type":"object","properties":{"Codes":{"type":"array","items":{"type":"string"}},"Type":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_5 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_5":{"type":"object","properties":{"LeadResponse":{"$ref":"#/components/schemas/UpdateLeadResponse"}}},"UpdateLeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"CreatedAt":{"type":"string"},"UpdatedAt":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/LeadResponse_Errors"}}}},"LeadResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_6 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_6":{"type":"object","properties":{"Items":{"$ref":"#/components/schemas/GetLeadResponse"},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"GetLeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"GeneratedFrom":{"type":"string"},"CartId":{"type":"string"},"Currency":{"type":"string"},"Language":{"type":"string"},"ExternalReference":{"type":"string"},"MachineId":{"type":"string"},"Items":{"$ref":"#/components/schemas/GetLeadResponse_Items"},"BillingDetails":{"$ref":"#/components/schemas/GetLeadResponse_BillingDetails"},"DeliveryDetails":{"$ref":"#/components/schemas/GetLeadResponse_DeliveryDetails"},"DeliveryInformation":{"$ref":"#/components/schemas/GetLeadResponse_DeliveryInformation"},"PaymentDetails":{"$ref":"#/components/schemas/GetLeadResponse_PaymentDetails"},"Promotions":{"type":"array","items":{"$ref":"#/components/schemas/GetLeadResponse_Promotions"}},"LocalTime":{"type":"string"}}},"GetLeadResponse_Items":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Item"}}},"Item":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"integer"},"SKU":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"PriceOptions":{"$ref":"#/components/schemas/Item_PriceOptions"},"RecurringOptions":{"$ref":"#/components/schemas/Item_RecurringOptions"},"MarketingCampaigns":{"$ref":"#/components/schemas/Item_MarketingCampaigns"},"Price":{"$ref":"#/components/schemas/Item_Price"},"AdditionalFields":{"$ref":"#/components/schemas/Item_AdditionalFields"},"SubscriptionStartDate":{"type":"string"},"Trial":{"$ref":"#/components/schemas/LeadTrial"}}},"Item_PriceOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptions"}}},"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}},"Item_RecurringOptions":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/RecurringOptions"}}},"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}},"Item_MarketingCampaigns":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/MarketingCampaigns"}}},"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}},"Item_Price":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Price"}}},"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"Item_AdditionalFields":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFields"}}},"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}},"LeadTrial":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}},"GetLeadResponse_BillingDetails":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/BillingDetails"}}},"BillingDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"GetLeadResponse_DeliveryDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}},"GetLeadResponse_DeliveryInformation":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryInformation"}}},"DeliveryInformation":{"type":"object","properties":{"ShippingMethod":{"$ref":"#/components/schemas/DeliveryInformation_ShippingMethod"}}},"DeliveryInformation_ShippingMethod":{"type":"object","properties":{"Code":{"type":"string"}}},"GetLeadResponse_PaymentDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PaymentDetails"}}},"PaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"PaymentMethod":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod"},"CustomerIP":{"type":"string"}}},"PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardPayment":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod_CardPayment"}}},"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}},"GetLeadResponse_Promotions":{"type":"object","properties":{"0":{"type":"string"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The inline\_response\_200\_7 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_7":{"type":"object","properties":{"LeadResponse":{"$ref":"#/components/schemas/LeadResponse"}}},"LeadResponse":{"type":"object","properties":{"LeadCode":{"type":"string"},"CreatedAt":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/LeadResponse_Errors"}}}},"LeadResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_8 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_8":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"SubscriptionResponse":{"type":"object","properties":{"SubscriptionReference":{"type":"string"},"StartDate":{"type":"string"},"ActivationDate":{"type":"string"},"ExpirationDate":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"NextBillingDate":{"type":"string","default":"null","minLength":0,"maxLength":25},"SubscriptionEnabled":{"type":"boolean"},"Product":{"$ref":"#/components/schemas/Product"},"EndUser":{"$ref":"#/components/schemas/EndUser"},"SKU":{"type":"string"},"DeliveryInfo":{"$ref":"#/components/schemas/DeliveryInfo"},"ReceiveNotifications":{"type":"boolean"},"Lifetime":{"type":"boolean"},"PartnerCode":{"type":"string"},"ReasonText":{"type":"string"},"IdAffiliate":{"type":"integer"},"CustomerReference":{"type":"string"},"ExternalCustomerReference":{"type":"string"},"TestSubscription":{"type":"boolean"},"IsTrial":{"type":"boolean"},"Status":{"type":"string"},"LatestSubscriptionOrder":{"$ref":"#/components/schemas/LatestSubscriptionOrder"},"IsAssistedSale":{"type":"boolean"},"Billing":{"type":"object","properties":{"Quantity":{"type":"integer"},"Currency":{"type":"string"},"UnitBillingPriceNet":{"type":"number"},"UnitBillingPriceGross":{"type":"number"},"BillingPriceNet":{"type":"number"},"BillingPriceGross":{"type":"number"},"NoOfBillingCycles":{"type":"integer"},"CurrentBillingCycle":{"type":"integer"},"PayedBillingCycles":{"type":"integer"},"RemainingBillingCycles":{"type":"integer"},"CurrentBillingCycleEndDate":{"type":"string"},"TaxAmount":{"type":"number"},"TaxPercent":{"type":"number"},"BillingCyclesFrequency":{"type":"integer"},"BillingCycleFrequencyUnit":{"type":"string"},"ContractLength":{"type":"string","nullable":true},"ContractLengthUnit":{"type":"string"},"PriceOptions":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string"},"Options":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string"}}}}}}},"ActivationKey":{"type":"string","nullable":true}}}},"required":["NextBillingDate"]},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}},"EndUser":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Zip":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Language":{"type":"string"}}},"DeliveryInfo":{"type":"object","properties":{"Description":{"type":"string"},"Codes":{"$ref":"#/components/schemas/DeliveryInfo_Codes"}}},"DeliveryInfo_Codes":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInfoCode"}},"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}},"LatestSubscriptionOrder":{"type":"object","properties":{"RefNo":{"type":"integer"},"Status":{"type":"string"},"FailedRecurringChargesCount":{"type":"integer"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## The subscriptions\_DeliveryInfo\_Codes object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptions_DeliveryInfo_Codes":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"nullable":true},"ExtraInfo":{"nullable":true},"File":{"nullable":true}}}}}} ``` ## The subscriptions\_DeliveryInfo object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptions_DeliveryInfo":{"type":"object","properties":{"Codes":{"type":"array","items":{"$ref":"#/components/schemas/subscriptions_DeliveryInfo_Codes"}},"Description":{"nullable":true}}},"subscriptions_DeliveryInfo_Codes":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"nullable":true},"ExtraInfo":{"nullable":true},"File":{"nullable":true}}}}}} ``` ## The subscriptions\_EndUser object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptions_EndUser":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Company":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"Fax":{"type":"string"},"FirstName":{"type":"string"},"Language":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}}}}} ``` ## The subscriptions\_Payment object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptions_Payment":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"}}}}}} ``` ## The subscriptions\_Product object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptions_Product":{"type":"object","properties":{"PriceOptionCodes":{"type":"array","items":{"type":"string"}},"ProductCode":{"type":"string"},"ProductId":{"type":"string"},"ProductName":{"type":"string"},"ProductQuantity":{"type":"number"},"ProductVersion":{"type":"string"}}}}}} ``` ## The body\_16 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_16":{"type":"object","properties":{"AdditionalInfo":{"nullable":true},"CustomPriceBillingCyclesLeft":{"type":"number"},"DeliveryInfo":{"$ref":"#/components/schemas/subscriptions_DeliveryInfo"},"EndUser":{"$ref":"#/components/schemas/subscriptions_EndUser"},"ExpirationDate":{"type":"string"},"ExternalCustomerReference":{"nullable":true},"ExternalSubscriptionReference":{"type":"string"},"NextRenewalPrice":{"type":"number"},"NextRenewalPriceCurrency":{"type":"string"},"PartnerCode":{"type":"string"},"Payment":{"$ref":"#/components/schemas/subscriptions_Payment"},"Product":{"$ref":"#/components/schemas/subscriptions_Product"},"StartDate":{"type":"string"},"ActivationDate":{"type":"string","nullable":true},"SubscriptionValue":{"type":"number"},"SubscriptionValueCurrency":{"type":"string"},"Test":{"type":"number"}}},"subscriptions_DeliveryInfo":{"type":"object","properties":{"Codes":{"type":"array","items":{"$ref":"#/components/schemas/subscriptions_DeliveryInfo_Codes"}},"Description":{"nullable":true}}},"subscriptions_DeliveryInfo_Codes":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"nullable":true},"ExtraInfo":{"nullable":true},"File":{"nullable":true}}},"subscriptions_EndUser":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Company":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"Fax":{"type":"string"},"FirstName":{"type":"string"},"Language":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}},"subscriptions_Payment":{"type":"object","properties":{"CCID":{"type":"string"},"CardNumber":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"string"},"HolderName":{"type":"string"}}},"subscriptions_Product":{"type":"object","properties":{"PriceOptionCodes":{"type":"array","items":{"type":"string"}},"ProductCode":{"type":"string"},"ProductId":{"type":"string"},"ProductName":{"type":"string"},"ProductQuantity":{"type":"number"},"ProductVersion":{"type":"string"}}}}}} ``` ## The subscriptionsSubscriptionReference\_Product object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"subscriptionsSubscriptionReference_Product":{"type":"object","properties":{"PriceOptionCodes":{"type":"array","items":{"type":"string"}},"ProductId":{"type":"string"},"ProductName":{"type":"string"},"ProductQuantity":{"type":"number"}}}}}} ``` ## The body\_17 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_17":{"type":"object","properties":{"EndUser":{"$ref":"#/components/schemas/subscriptions_EndUser"},"StartDate":{"type":"string"},"ExpirationDate":{"type":"string"},"ExternalCustomerReference":{"nullable":true},"Product":{"$ref":"#/components/schemas/subscriptionsSubscriptionReference_Product"},"RecurringEnabled":{"type":"boolean"},"SubscriptionEnabled":{"type":"boolean"},"ChurnReasons":{"type":"array","items":{"type":"string"}},"ChurnReasonOther":{"type":"string"}}},"subscriptions_EndUser":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Company":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"Fax":{"type":"string"},"FirstName":{"type":"string"},"Language":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"}}},"subscriptionsSubscriptionReference_Product":{"type":"object","properties":{"PriceOptionCodes":{"type":"array","items":{"type":"string"}},"ProductId":{"type":"string"},"ProductName":{"type":"string"},"ProductQuantity":{"type":"number"}}}}}} ``` ## The body\_18 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_18":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The body\_19 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_19":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The body\_20 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_20":{"type":"object","properties":{"ExternalCustomerReference":{"type":"string"},"AvangateCustomerReference":{"type":"integer"}}}}}} ``` ## The body\_24 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_24":{"type":"object","properties":{"validationURL":{"type":"string"}}}}}} ``` ## The body\_25 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_25":{"type":"object","properties":{"ApplePayData":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_9 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_9":{"properties":{"Type":{"type":"string"},"Currency":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/inline_response_200_9_PaymentMethod"}}},"inline_response_200_9_PaymentMethod":{"type":"object","properties":{"FirstDigits":{"type":"string"},"LastDigits":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"integer"},"CardUpdated":{"type":"boolean"},"Authorize3DSUrl":{"type":"string"}}}}}} ``` ## The body\_21 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_21":{"type":"object","properties":{"Currency":{"type":"string"},"Days":{"type":"number"},"ExtendSubscription":{"nullable":true},"Price":{"type":"number"}}}}}} ``` ## The body\_22 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_22":{"type":"object","properties":{"Cycles":{"type":"number"},"Currency":{"type":"string"},"Price":{"type":"number"},"Text":{"type":"string"}}}}}} ``` ## The body\_23 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"body_23":{"type":"object","properties":{"CustomPrice":{"type":"number"},"ExternalRef":{"nullable":true},"PriceOptions":{"type":"string"},"ProductCode":{"type":"string"},"Quantity":{"type":"number"}}}}}} ``` ## The inline\_response\_200\_10 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_10":{"required":["limit","page","proposals","proposalsCount","pagesCount"],"type":"object","properties":{"page":{"type":"integer","description":"The incoming page value"},"limit":{"type":"integer","description":"The incoming limit value"},"proposals":{"type":"array","description":"The matching proposals collection","items":{"$ref":"#/components/schemas/Proposal"}},"proposalsCount":{"type":"integer","description":"The total number of proposal matching the criterias"},"pagesCount":{"type":"integer","description":"The total number of pages for proposal matching the criterias"}}},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."}}}} ``` ## The SearchProposalHistoryById object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchProposalHistoryById":{"required":["limit","page","versions","count"],"type":"object","properties":{"page":{"type":"integer","description":"The incoming page value"},"limit":{"type":"integer","description":"The incoming limit value"},"versions":{"type":"array","description":"The matching proposal versions collection","items":{"$ref":"#/components/schemas/Proposal"}},"count":{"type":"integer","description":"The total number of proposal versions matching the criterias"}}},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."}}}} ``` ## The GetPrice\_Item object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPrice_Item":{"required":["Code","Quantity"],"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"string"},"PriceOptions":{"type":"array","items":{}}}}}}} ``` ## The GetPrice\_BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetPrice_BillingDetails":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Zip":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"}}}}}} ``` ## The PlaceOrder\_Price object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}}}}} ``` ## The PlaceOrder\_RenewalInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_RenewalInformation":{"type":"object","description":"Used for manual renewal orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be renewed."},"Code":{"type":"string","description":"The unique code defined for your product. Required for manual renewal only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for manual renewal only if you wish to change the product quantity on the subscription."}}}}}} ``` ## The PlaceOrder\_UpgradeInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_UpgradeInformation":{"type":"object","description":"Used for upgrade orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be upgraded."},"Code":{"type":"string","description":"The unique code defined for your product. Required for upgrade order only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for upgrade order only if you wish to change the product quantity on the subscription."}}}}}} ``` ## The PlaceOrder\_TrialInput object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_TrialInput":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}}}}} ``` ## The PlaceOrder\_ItemCrossSell object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_ItemCrossSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"AutoAdded":{"type":"boolean"}}}}}} ``` ## The PlaceOrder\_ItemUpSell object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_ItemUpSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"PriceOptions":{"type":"array","items":{"type":"string"}},"Quantity":{"type":"integer"}}}}}} ``` ## The PlaceOrder\_ItemPromotion object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_ItemPromotion":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The PlaceOrder\_Options object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_Options":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"integer"}}}}}} ``` ## The PlaceOrder\_PriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_Options"}}}},"PlaceOrder_Options":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"integer"}}}}}} ``` ## The PlaceOrder\_RecurringOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"]},"CycleAmount":{"type":"number"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR","FOREVER"]}}}}}} ``` ## The PlaceOrder\_Items object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_Items":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code defined for your product."},"RenewalInformation":{"$ref":"#/components/schemas/PlaceOrder_RenewalInformation"},"UpgradeInformation":{"$ref":"#/components/schemas/PlaceOrder_UpgradeInformation"},"Name":{"type":"string"},"Description":{"type":"string"},"Quantity":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"Price":{"$ref":"#/components/schemas/PlaceOrder_Price"},"ProductTaxCategoryUUID":{"type":"string"},"PriceType":{"type":"string"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_PriceOptions"}},"CrossSell":{"$ref":"#/components/schemas/PlaceOrder_ItemCrossSell"},"UpSell":{"$ref":"#/components/schemas/PlaceOrder_ItemUpSell"},"RecurringOptions":{"$ref":"#/components/schemas/PlaceOrder_RecurringOptions"},"SubscriptionCustomSettings":{"$ref":"#/components/schemas/Item_SubscriptionCustomSettings"},"Trial":{"$ref":"#/components/schemas/PlaceOrder_TrialInput"},"Promotion":{"$ref":"#/components/schemas/PlaceOrder_ItemPromotion"}}},"PlaceOrder_RenewalInformation":{"type":"object","description":"Used for manual renewal orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be renewed."},"Code":{"type":"string","description":"The unique code defined for your product. Required for manual renewal only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for manual renewal only if you wish to change the product quantity on the subscription."}}},"PlaceOrder_UpgradeInformation":{"type":"object","description":"Used for upgrade orders.","properties":{"SubscriptionReference":{"type":"string","description":"Unique, system-generated subscription identifier of the subscription that needs to be upgraded."},"Code":{"type":"string","description":"The unique code defined for your product. Required for upgrade order only if you wish to change the product on the subscription."},"Quantity":{"type":"string","description":"Number of units. Required for upgrade order only if you wish to change the product quantity on the subscription."}}},"PlaceOrder_Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"PlaceOrder_PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PlaceOrder_Options"}}}},"PlaceOrder_Options":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"integer"}}},"PlaceOrder_ItemCrossSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"AutoAdded":{"type":"boolean"}}},"PlaceOrder_ItemUpSell":{"type":"object","properties":{"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"},"PriceOptions":{"type":"array","items":{"type":"string"}},"Quantity":{"type":"integer"}}},"PlaceOrder_RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"]},"CycleAmount":{"type":"number"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR","FOREVER"]}}},"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}},"PlaceOrder_TrialInput":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}},"PlaceOrder_ItemPromotion":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The PlaceOrder\_BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_BillingDetails":{"required":["Address1","City","CountryCode","Email","FirstName","LastName","State","Zip"],"type":"object","properties":{"Address1":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Zip":{"type":"string"}}}}}} ``` ## The PlaceOrder\_PaymentDetails\_PaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardNumber":{"type":"string"},"CardType":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"},"ExpirationYear":{"type":"string"},"ExpirationMonth":{"type":"string"},"CCID":{"type":"string"},"HolderName":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"HolderNameTime":{"type":"integer"},"CardNumberTime":{"type":"integer"}}}}}} ``` ## The PlaceOrder\_PaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_PaymentDetails":{"required":["Currency","Type"],"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string","description":"The currency ISO code for the payment - ISO 4217. Can be changed for the method \"Place an order with manual renewal\" to set a common currency for multiple subscriptions renewed via the same order."},"CustomerIP":{"type":"string"},"PaymentMethod":{"$ref":"#/components/schemas/PlaceOrder_PaymentDetails_PaymentMethod"}}},"PlaceOrder_PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardNumber":{"type":"string"},"CardType":{"type":"string"},"Vendor3DSReturnURL":{"type":"string"},"Vendor3DSCancelURL":{"type":"string"},"ExpirationYear":{"type":"string"},"ExpirationMonth":{"type":"string"},"CCID":{"type":"string"},"HolderName":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"HolderNameTime":{"type":"integer"},"CardNumberTime":{"type":"integer"}}}}}} ``` ## The SearchPayoutsItems\_Summary object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SearchPayoutsItems_Summary":{"type":"object","properties":{"ServicesAmount":{"type":"number"},"PurchaseOrdersAmount":{"type":"number"},"ChargeBacksAmount":{"type":"number"},"RollingReserveAmount":{"type":"number"},"PeriodNetSales":{"type":"number"},"VendorToVendor":{"type":"number"},"ChargeBackFund":{"type":"number"}}}}}} ``` ## The PendingPayouts\_Total\_OrdersTotal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PendingPayouts_Total_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}}}}} ``` ## The PendingPayouts\_Total object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PendingPayouts_Total":{"type":"object","properties":{"Currency":{"type":"string"},"OrdersTotal":{"$ref":"#/components/schemas/PendingPayouts_Total_OrdersTotal"},"RetainedToDisputesBalance":{"type":"number"},"ReleasedFromDisputesBalance":{"type":"number"},"RetainedToRollingReserveBalance":{"type":"number"},"ReleasedFromRollingReserveBalance":{"type":"number"},"ChargebackFees":{"type":"number"},"ProcessingFees":{"type":"number"},"AffiliatesCommission":{"type":"number"},"TaxCollected":{"type":"number"},"EstimatedTotalRevenue":{"type":"number"}}},"PendingPayouts_Total_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}}}}} ``` ## The PendingPayoutsCurrencies\_OrdersTotal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PendingPayoutsCurrencies_OrdersTotal":{"type":"object","properties":{"estore":{"type":"number"},"affilietes":{"type":"number"},"partner":{"type":"number"},"total":{"type":"number"}}}}}} ``` ## The LeadResponse\_Errors object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"LeadResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The GetLeadResponse\_Items object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_Items":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Item"}}},"Item":{"type":"object","properties":{"Code":{"type":"string"},"Quantity":{"type":"integer"},"SKU":{"type":"string"},"IsDynamic":{"type":"boolean"},"Tangible":{"type":"boolean"},"PurchaseType":{"type":"string"},"PriceOptions":{"$ref":"#/components/schemas/Item_PriceOptions"},"RecurringOptions":{"$ref":"#/components/schemas/Item_RecurringOptions"},"MarketingCampaigns":{"$ref":"#/components/schemas/Item_MarketingCampaigns"},"Price":{"$ref":"#/components/schemas/Item_Price"},"AdditionalFields":{"$ref":"#/components/schemas/Item_AdditionalFields"},"SubscriptionStartDate":{"type":"string"},"Trial":{"$ref":"#/components/schemas/LeadTrial"}}},"Item_PriceOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptions"}}},"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}},"Item_RecurringOptions":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/RecurringOptions"}}},"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}},"Item_MarketingCampaigns":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/MarketingCampaigns"}}},"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}},"Item_Price":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Price"}}},"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}},"Item_AdditionalFields":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFields"}}},"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}},"LeadTrial":{"type":"object","properties":{"Period":{"type":"integer"},"Price":{"type":"number"}}}}}} ``` ## The GetLeadResponse\_BillingDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_BillingDetails":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/BillingDetails"}}},"BillingDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The GetLeadResponse\_DeliveryDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_DeliveryDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryDetails"}}},"DeliveryDetails":{"type":"object","properties":{"Phone":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Email":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"Zip":{"type":"string"},"CountryCode":{"type":"string"},"State":{"type":"string"}}}}}} ``` ## The GetLeadResponse\_DeliveryInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_DeliveryInformation":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/DeliveryInformation"}}},"DeliveryInformation":{"type":"object","properties":{"ShippingMethod":{"$ref":"#/components/schemas/DeliveryInformation_ShippingMethod"}}},"DeliveryInformation_ShippingMethod":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The GetLeadResponse\_PaymentDetails object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_PaymentDetails":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PaymentDetails"}}},"PaymentDetails":{"type":"object","properties":{"Type":{"type":"string"},"Currency":{"type":"string"},"RecurringEnabled":{"type":"boolean"},"PaymentMethod":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod"},"CustomerIP":{"type":"string"}}},"PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardPayment":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod_CardPayment"}}},"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}}}}} ``` ## The GetLeadResponse\_Promotions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetLeadResponse_Promotions":{"type":"object","properties":{"0":{"type":"string"}}}}}} ``` ## The Item\_PriceOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_PriceOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptions"}}},"PriceOptions":{"type":"object","properties":{"Name":{"type":"string"},"Options":{"$ref":"#/components/schemas/PriceOptions_Options"}}},"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}}}}} ``` ## The Item\_RecurringOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_RecurringOptions":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/RecurringOptions"}}},"RecurringOptions":{"type":"object","properties":{"CycleLength":{"type":"integer"},"CycleUnit":{"type":"string"},"CycleAmount":{"type":"integer"},"ContractLength":{"type":"integer"},"ContractUnit":{"type":"string"}}}}}} ``` ## The Item\_MarketingCampaigns object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_MarketingCampaigns":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/MarketingCampaigns"}}},"MarketingCampaigns":{"type":"object","properties":{"Type":{"type":"integer"},"ParentCode":{"type":"string"},"CampaignCode":{"type":"integer"}}}}}} ``` ## The Item\_Price object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_Price":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/Price"}}},"Price":{"type":"object","properties":{"Amount":{"type":"integer"},"Type":{"type":"string"}}}}}} ``` ## The Item\_AdditionalFields object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_AdditionalFields":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFields"}}},"AdditionalFields":{"type":"object","properties":{"Code":{"type":"string"},"Text":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The PriceOptions\_Options object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PriceOptions_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/PriceOptionsOption"}}},"PriceOptionsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Surcharge":{"type":"number"}}}}}} ``` ## The DeliveryInformation\_ShippingMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryInformation_ShippingMethod":{"type":"object","properties":{"Code":{"type":"string"}}}}}} ``` ## The PaymentDetails\_PaymentMethod\_CardPayment object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}}}}} ``` ## The PaymentDetails\_PaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PaymentDetails_PaymentMethod":{"type":"object","properties":{"CardPayment":{"$ref":"#/components/schemas/PaymentDetails_PaymentMethod_CardPayment"}}},"PaymentDetails_PaymentMethod_CardPayment":{"type":"object","properties":{"InstallmentsNumber":{"type":"number"}}}}}} ``` ## The SubscriptionResponse\_Product object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SubscriptionResponse_Product":{"$ref":"#/components/schemas/Product"},"Product":{"type":"object","properties":{"AvangateId":{"type":"integer","description":"Unique, system-generated product ID (read-only)","nullable":true},"ProductCode":{"type":"string","description":"The unique product code you can define for each of your offerings"},"ExternalReference":{"type":"string","description":"External reference set when defining the product"},"ProductType":{"type":"string","enum":["REGULAR","BUNDLE"],"default":"REGULAR","description":"The type of the product (REGULAR or BUNDLE)"},"ProductName":{"type":"string","description":"The name of the product"},"ProductVersion":{"type":"string","description":"The product version number"},"ProductGroup":{"$ref":"#/components/schemas/Product_ProductGroup"},"PurchaseMultipleUnits":{"type":"boolean","description":"Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product","default":true},"ShippingClass":{"$ref":"#/components/schemas/products_ShippingClass"},"GiftOption":{"type":"boolean","default":false,"description":"True or false depending on whether the product can be gifted or not"},"ShortDescription":{"type":"string","default":"","description":"Product's short description"},"LongDescription":{"type":"string","default":"","description":"Product's long description"},"SystemRequirements":{"type":"string","default":"","description":"System requirements"},"ProductCategory":{"oneOf":[{"type":"string"},{"type":"boolean","default":false}],"description":"Product's category name"},"Platforms":{"type":"array","items":{"$ref":"#/components/schemas/products_Platforms"}},"ProductImages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/products_ProductImages"}},"TrialUrl":{"type":"string","default":"","description":"The URL where shoppers can download trial software from"},"TrialDescription":{"type":"string","default":"","description":"Descriptive text entered for trials"},"Tangible":{"type":"boolean","description":"TRUE - for physical products, FALSE - for digital products"},"TangibleDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Product_TangibleDetails"}]},"Enabled":{"type":"boolean","default":false,"description":"True/false depending on whether the products are active or disabled"},"ReviewProductUrl":{"type":"boolean","default":"","description":"The URL where the product can be reviewed before approval. Required if the \"Enabled\" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation."},"ReviewAdditionalDetails":{"type":"boolean","default":"","description":"Additional information can be added to access the review of the product. Parameter is optional."},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/products_AdditionalFields"}},"Translations":{"type":"array","items":{"$ref":"#/components/schemas/products_Translations"}},"PricingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/products_PricingConfigurations"}},"BundleProducts":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/product_BundledProducts"}},"Fulfillment":{"type":"string","enum":["NO_DELIVERY","INHERIT","BY_AVANGATE","BY_VENDOR"],"description":"Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY"},"Prices":{"type":"array","description":"to be used when Pricing Configurations are not available for your account","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"GeneratesSubscription":{"type":"boolean","default":false,"description":"TRUE or FALSE depending on whether you set the product to generate subscriptions or not"},"SubscriptionInformation":{"$ref":"#/components/schemas/products_SubscriptionInformation"},"FulfillmentInformation":{"$ref":"#/components/schemas/products_FulfillmentInformation"}}},"Product_ProductGroup":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Description":{"type":"string"},"Name":{"type":"string"},"TemplateName":{"type":"string"}}},"products_ShippingClass":{"type":"object","properties":{"Amount":{"type":"string","description":"The shipping costs"},"ApplyTo":{"type":"string","description":"Possible values • PRODUCT • ORDER","nullable":true},"Currency":{"type":"string","description":"The currency ISO code used for shipping costs - ISO 4217."},"Name":{"type":"string","description":"The name of the shipping class"},"Type":{"type":"string","description":"Possible values • FIXED • PERCENT"}}},"products_Platforms":{"required":["Category","IdPlatform","PlatformName"],"type":"object","properties":{"Category":{"type":"string","description":"Platform category per product configuration."},"IdPlatform":{"type":"string"},"PlatformName":{"type":"string","description":"The label of the platform per the product configuration."}}},"products_ProductImages":{"type":"object","properties":{"Default":{"type":"boolean","description":"True or False depending on whether you set the image stored at the address in the URL parameter as default or not."},"URL":{"type":"string","description":"The location of the image on the 2Checkout system."}}},"Product_TangibleDetails":{"type":"object","description":"Relevant only for tangible products; contains physical product setup information","properties":{"UnitDetails":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_UnitDetails"}},"Fee":{"type":"array","items":{"$ref":"#/components/schemas/Product_TangibleDetails_HandlingFee"}}}},"Product_TangibleDetails_UnitDetails":{"type":"object","properties":{"Type":{"type":"string","description":"Product physical configuration type"},"Amount":{"type":"number","format":"float","description":"Product's tangible configuration type value"}}},"Product_TangibleDetails_HandlingFee":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency of the handling fee"},"Amount":{"type":"number","format":"float","description":"Handling fee amount defined on the tangible product"}}},"products_AdditionalFields":{"type":"object","properties":{"Code":{"type":"string","description":"The code of the additional field assigned to a product."},"Enabled":{"type":"boolean","description":"True or false depending on whether the assigned product field is enabled or not."},"Label":{"type":"string","description":"The name of the additional field assigned to a product."},"Required":{"type":"boolean","description":"True or false depending on whether the assigned product field is required or not."},"URLParameter":{"type":"string","description":"The value of the system generated URL parameter for the product field that can be used in Buy Links."}}},"products_Translations":{"type":"object","properties":{"Description":{"type":"string","description":"Localized product short description."},"Language":{"type":"string","description":"ISO 639-1 two-letter code."},"LongDescription":{"type":"string","description":"The translated long description in the language corresponding to the Translation object."},"Name":{"type":"string","description":"Localized product name."},"SystemRequirements":{"type":"string","description":"Localized system requirements.","nullable":true},"TrialDescription":{"type":"string","nullable":true},"TrialUrl":{"type":"string","description":"The trial URL for users speaking the language corresponding to the Translation object.","nullable":true}}},"products_PricingConfigurations":{"type":"object","properties":{"BillingCountries":{"type":"array","description":"ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.","items":{"type":"string"}},"Code":{"type":"string","description":"System-generated identifier."},"Default":{"type":"boolean","description":"True for the default pricing configuration"},"DefaultCurrency":{"type":"string","description":"The ISO code of the default currency for the pricing configuration"},"Name":{"type":"string","description":"Pricing configuration name"},"PriceOptions":{"type":"array","items":{"$ref":"#/components/schemas/products_PriceOptions"}},"PriceType":{"type":"string","description":"Possible values - NET / GROSS"},"Prices":{"type":"array","items":{"$ref":"#/components/schemas/Product_PricingConfiguration_Price"}},"PricingSchema":{"type":"string","description":"DYNAMIC – With a base price or FLAT – Without a base price"}}},"products_PriceOptions":{"required":["Code","Required"],"type":"object","properties":{"Code":{"type":"string","description":"Price option identifier."},"Required":{"type":"boolean","description":"True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process."}}},"Product_PricingConfiguration_Price":{"required":["Amount","Currency","MaxQuantity","MinQuantity","OptionCodes"],"type":"object","properties":{"Amount":{"type":"number","description":"The price of the product."},"Currency":{"type":"string","description":"ISO code of the currency for the product price."},"MaxQuantity":{"type":"string","description":"The maximum quantity of volume discounts. Default is 99999."},"MinQuantity":{"type":"string","description":"The minimum quantity of volume discounts. Default is 1."},"OptionCodes":{"type":"array","items":{}}}},"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}},"products_SubscriptionInformation":{"type":"object","properties":{"BillingCycle":{"type":"string"},"BillingCycleUnits":{"type":"string","description":"The units of the billing cycle - M for months or D for days"},"BundleRenewalManagement":{"type":"string","description":"The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)"},"ContractPeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_ContractPeriod"},"DeprecatedProducts":{"type":"array","items":{"type":"string","description":"Deprecated products."}},"GracePeriod":{"$ref":"#/components/schemas/products_SubscriptionInformation_GracePeriod"},"IsOneTimeFee":{"type":"boolean","description":"True or False depending on whether the subscription is evergreen or not."},"RenewalEmails":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails"},"UsageBilling":{"type":"number"}}},"products_SubscriptionInformation_ContractPeriod":{"type":"object","properties":{"Action":{"type":"string","description":"The action performed after the subscription expires. Possible values CANCEL | RESTART"},"EmailsDuringContract":{"type":"boolean","description":"True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not."},"IsUnlimited":{"type":"boolean","description":"This flag is true if the contract is for an unlimited period"},"Period":{"type":"number","description":"The contract period in months or days. -1 for unlimited contracts."},"PeriodUnits":{"type":"string","nullable":true,"description":"The contract period units - days | months"}}},"products_SubscriptionInformation_GracePeriod":{"type":"object","properties":{"IsUnlimited":{"type":"boolean","description":"TRUE or FALSE depending on whether you set the grace period to unlimited or not."},"Period":{"type":"string","description":"Number of days set for the grace period."},"PeriodUnits":{"type":"string","description":"D - Days."},"Type":{"type":"string","description":"CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply."}}},"products_SubscriptionInformation_RenewalEmails":{"type":"object","properties":{"Settings":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings"},"Type":{"type":"string","description":"GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings"}}},"products_SubscriptionInformation_RenewalEmails_Settings":{"type":"object","properties":{"AutomaticRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"},"ManualRenewal":{"$ref":"#/components/schemas/products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal"}}},"products_SubscriptionInformation_RenewalEmails_Settings_AutomaticRenewal":{"type":"object","properties":{"After15Days":{"type":"boolean","description":"True or False."},"After5Days":{"type":"boolean","description":"True or False."},"Before15Days":{"type":"boolean","description":"True or False."},"Before1Day":{"type":"boolean","description":"True or False."},"Before30Days":{"type":"boolean","description":"True or False."},"Before7Days":{"type":"boolean","description":"True or False."},"OnExpirationDate":{"type":"boolean","description":"True or False."}}},"products_FulfillmentInformation":{"type":"object","properties":{"AdditionalInformationByEmail":{"type":"string","description":"The text you set up in the Additional fulfillment information - by email area."},"AdditionalInformationEmailTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"AdditionalThankYouPage":{"type":"string","description":"The text you set up in the Additional fulfillment information - \"Thank you\" page area."},"AdditionalThankYouPageTranslations":{"type":"array","items":{"$ref":"#/components/schemas/products_FulfillmentInformation_AdditionalInformationEmailTranslations"}},"BackupMedia":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"CodeList":{"$ref":"#/components/schemas/products_FulfillmentInformation_BackupMedia"},"IsBackupMedia":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of backup media or not."},"IsDisplayInPartnersCPanel":{"type":"boolean","description":"True or False. Depending on whether you share access to the product file with your channel partners or not."},"IsDownloadInsuranceService":{"type":"boolean","description":"True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file."},"IsDownloadLink":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of a product file or not."},"IsElectronicCode":{"type":"boolean","description":"True or False. Depending on whether you configure the delivery of keys/codes for the product or not."},"IsInstantDeliveryThankYouPage":{"type":"boolean"},"IsStartAfterFulfillment":{"type":"boolean","description":"True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not."},"ProductFile":{"$ref":"#/components/schemas/products_FulfillmentInformation_ProductFile"}}},"products_FulfillmentInformation_AdditionalInformationEmailTranslations":{"type":"object","properties":{"Description":{"type":"string","description":"Array of localized Additional fulfillment information - \"Thank you\" page texts."},"Language":{"type":"string"},"Name":{"type":"string","nullable":true}}},"products_FulfillmentInformation_BackupMedia":{"type":"object","properties":{"Code":{"type":"string","description":"The unique code list identifier."},"Name":{"type":"string","description":"Name of the code list."},"Type":{"type":"string","description":"Code list type Static or Dynamic"}}},"products_FulfillmentInformation_ProductFile":{"type":"object","properties":{"Code":{"type":"string","description":"Unique product file identifier."},"File":{"type":"string","description":"Name of the product file."},"LastUpdate":{"type":"string","description":"YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file."},"Name":{"type":"string","description":"Display name."},"Size":{"type":"string","description":"File size."},"Type":{"type":"string","description":"File type."},"Version":{"type":"string","description":"File version."}}}}}} ``` ## The SubscriptionResponse\_EndUser object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SubscriptionResponse_EndUser":{"$ref":"#/components/schemas/EndUser"},"EndUser":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"FiscalCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Zip":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"CountryCode":{"type":"string"},"Language":{"type":"string"}}}}}} ``` ## The SubscriptionResponse\_DeliveryInfo object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SubscriptionResponse_DeliveryInfo":{"$ref":"#/components/schemas/DeliveryInfo"},"DeliveryInfo":{"type":"object","properties":{"Description":{"type":"string"},"Codes":{"$ref":"#/components/schemas/DeliveryInfo_Codes"}}},"DeliveryInfo_Codes":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInfoCode"}},"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}}}}} ``` ## The SubscriptionResponse\_LatestSubscriptionOrder object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SubscriptionResponse_LatestSubscriptionOrder":{"$ref":"#/components/schemas/LatestSubscriptionOrder"},"LatestSubscriptionOrder":{"type":"object","properties":{"RefNo":{"type":"integer"},"Status":{"type":"string"},"FailedRecurringChargesCount":{"type":"integer"}}}}}} ``` ## The DeliveryInfo\_Codes object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"DeliveryInfo_Codes":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInfoCode"}},"DeliveryInfoCode":{"type":"object","properties":{"Code":{"type":"string"},"File":{"type":"string"},"Description":{"type":"string"},"ExtraInfo":{"type":"string"}}}}}} ``` ## The ProductSkuSearchResponse\_PricingConfigurations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProductSkuSearchResponse_PricingConfigurations":{"type":"object","properties":{"Code":{"type":"string"},"Currencies":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"PurchaseTypes":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseType"}},"QuantityIntervals":{"type":"array","items":{"$ref":"#/components/schemas/QuantityInterval"}},"PriceOptionGroups":{"type":"array","items":{"$ref":"#/components/schemas/PriceOptionGroup"}},"SkuCollection":{"type":"array","items":{"$ref":"#/components/schemas/Sku"}}}},"Currency":{"type":"object","properties":{"Code":{"type":"string"}}},"PurchaseType":{"type":"object","properties":{"Code":{"type":"string"}}},"QuantityInterval":{"type":"object","properties":{"MinQuantity":{"type":"number"},"MaxQuantity":{"type":"number"}}},"PriceOptionGroup":{"type":"object","properties":{"Code":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/PriceOption"}}}},"PriceOption":{"type":"object","properties":{"OptionValue":{"type":"string"}}},"Sku":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptions"}}}},"SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetails"}}}},"SkuPricingOptionsDetails":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"number"},"ToQty":{"type":"number"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsDetails_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsDetails\_Groups object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsDetails_Groups":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsOption"}}}},"SkuPricingOptionsDetailsOption":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsDetailsForSchema\_Details object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsDetailsForSchema_Details":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"},"1":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"}}},"SkuPricingOptionsForSchema":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"integer"},"ToQty":{"type":"integer"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsForSchema\_Groups\_0\_Options\_0 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsForSchema\_Groups\_0\_Options object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsForSchema\_Groups\_0 object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The SkuPricingOptionsForSchema\_Groups object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}}}}} ``` ## The ValidationErrorsSkuPricingOptionsDetails\_SkuPricingOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"object","nullable":true},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The AffiliateResponse\_CommissionList object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AffiliateResponse_CommissionList":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/CommissionList"}}},"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}}}}} ``` ## The AffiliateResponse\_AffiliateContact object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AffiliateResponse_AffiliateContact":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/AffiliateContact"}}},"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The AdditionalFieldsResponseItems\_Translations object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFieldsResponseItems_Translations":{"type":"object","properties":{"en":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"},"fr":{"$ref":"#/components/schemas/AdditionalFieldsTranslations"}}},"AdditionalFieldsTranslations":{"type":"object","properties":{"Label":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}},"Language":{"type":"string"}}}}}} ``` ## The AdditionalFieldsResponseItems\_Display object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"AdditionalFieldsResponseItems_Display":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"},"1":{"$ref":"#/components/schemas/AdditionalFieldsDisplay"}}},"AdditionalFieldsDisplay":{"type":"object","properties":{"Type":{"type":"string"},"Active":{"type":"boolean"},"Required":{"type":"boolean"}}}}}} ``` ## The MarkLeadsResponse\_Errors object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"MarkLeadsResponse_Errors":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}}}}} ``` ## The ProposalCreateRequest\_Tac object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalCreateRequest_Tac":{"required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"}}}} ``` ## The ProposalLineItem\_BillingCycle object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"}}}} ``` ## The FilteredUsagesResponse\_Pagination object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"FilteredUsagesResponse_Pagination":{"type":"object","properties":{"Page":{"type":"integer","description":"Current page"},"Limit":{"type":"integer","description":"Max number of results per page"},"Count":{"type":"integer","description":"The total number of results"}}}}}} ``` ## The inline\_response\_200\_SkuPricingOptions object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_SkuPricingOptions":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsForSchema"},"1":{"$ref":"#/components/schemas/ValidationErrorsSkuPricingOptionsDetails"}}},"SkuPricingOptionsDetailsForSchema":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"$ref":"#/components/schemas/SkuPricingOptionsDetailsForSchema_Details"},"Errors":{"type":"array","items":{"type":"string"}}}},"SkuPricingOptionsDetailsForSchema_Details":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"},"1":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema"}}},"SkuPricingOptionsForSchema":{"type":"object","properties":{"ProductSKU":{"type":"string"},"Currency":{"type":"string"},"FromQty":{"type":"integer"},"ToQty":{"type":"integer"},"PurchaseType":{"type":"string"},"Groups":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups"},"Options":{"type":"string"}}},"SkuPricingOptionsForSchema_Groups":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0"}}},"SkuPricingOptionsForSchema_Groups_0":{"type":"object","properties":{"GroupCode":{"type":"string"},"Options":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options"}}},"SkuPricingOptionsForSchema_Groups_0_Options":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/SkuPricingOptionsForSchema_Groups_0_Options_0"}}},"SkuPricingOptionsForSchema_Groups_0_Options_0":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}},"ValidationErrorsSkuPricingOptionsDetails":{"type":"object","properties":{"ProductCode":{"type":"string"},"SkuPricingOptions":{"$ref":"#/components/schemas/ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions"}}},"ValidationErrorsSkuPricingOptionsDetails_SkuPricingOptions":{"type":"object","properties":{"Code":{"type":"string"},"Details":{"type":"object","nullable":true},"Errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The inline\_response\_200\_2\_Affiliates object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_2_Affiliates":{"type":"object","properties":{"0":{"$ref":"#/components/schemas/AffiliateResponse"},"1":{"$ref":"#/components/schemas/AffiliateResponse"}}},"AffiliateResponse":{"type":"object","properties":{"AffiliateCode":{"type":"string"},"Status":{"type":"string"},"Affiliate Name":{"type":"string"},"Website":{"type":"string"},"CommissionList":{"$ref":"#/components/schemas/AffiliateResponse_CommissionList"},"RequestDate":{"type":"string"},"Categories":{"type":"array","items":{"type":"string"}},"TCStatus":{"type":"string"},"AffiliateContact":{"$ref":"#/components/schemas/AffiliateResponse_AffiliateContact"}}},"AffiliateResponse_CommissionList":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/CommissionList"}}},"CommissionList":{"type":"object","properties":{"ListName":{"type":"string"},"CommissionRate":{"type":"string"}}},"AffiliateResponse_AffiliateContact":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/AffiliateContact"}}},"AffiliateContact":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Country":{"type":"string"}}}}}} ``` ## The inline\_response\_200\_9\_PaymentMethod object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"inline_response_200_9_PaymentMethod":{"type":"object","properties":{"FirstDigits":{"type":"string"},"LastDigits":{"type":"string"},"CardType":{"type":"string"},"ExpirationMonth":{"type":"string"},"ExpirationYear":{"type":"integer"},"CardUpdated":{"type":"boolean"},"Authorize3DSUrl":{"type":"string"}}}}}} ``` ## The PlaceOrder\_ExtraInformation object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"PlaceOrder_ExtraInformation":{"type":"object","properties":{"RetryFailedPaymentLink":{"type":"string","format":"url","description":"One of the url query params must be \"[REFNO]\""},"ProposalId":{"type":"string","maximum":36},"PurchaseOrderDownloadLink":{"type":"string","format":"url"},"AssistedSale":{"type":"boolean"},"AssistedSaleAccountManagerEmail":{"type":"string"}}}}}} ``` ## The Item\_SubscriptionCustomSettings object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"Item_SubscriptionCustomSettings":{"type":"object","required":["CycleUnit","CycleLength","CycleAmount","CycleAmountType"],"properties":{"CycleLength":{"type":"integer","nullable":true,"minimum":1},"CycleUnit":{"type":"string","enum":["DAY","MONTH"],"nullable":true},"CycleAmount":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true},"CycleAmountType":{"type":"string","enum":["NET","GROSS"]}}}}}} ``` ## The ContractLength object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ContractLength":{"type":"integer","nullable":true,"minimum":1,"description":"Must be multiple of cycle length value"}}}} ``` ## The ClientDealAutoRenewal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ClientDealAutoRenewal":{"type":"boolean","default":false}}}} ``` ## The MerchantDealAutoRenewal object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"MerchantDealAutoRenewal":{"type":"boolean","default":false}}}} ``` ## The SetMerchantDealAutoRenewalResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SetMerchantDealAutoRenewalResponse":{"type":"object","properties":{"MerchantDealAutoRenewal":{"type":"boolean"}}}}}} ``` ## The SetClientDealAutoRenewalResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"SetClientDealAutoRenewalResponse":{"type":"object","properties":{"ClientDealAutoRenewal":{"type":"boolean"}}}}}} ``` ## The CancelDealRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CancelDealRequest":{"type":"object","properties":{"CancelTime":{"type":"string","description":"Schedules cancelation","enum":["TODAY_END_OF_DAY","END_OF_BILLING_CYCLE"]},"ChurnReasons":{"type":"array","items":{"type":"string"},"description":"Churn reason codes"},"ChurnReasonOther":{"type":"string"}}}}}} ``` ## The CreateEesToken object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreateEesToken":{"type":"object","required":["CreditCard","Cvv","ExpirationDate"],"properties":{"Name":{"type":"string","description":"Name of the cardholder"},"CreditCard":{"type":"string","description":"Credit card number"},"Cvv":{"type":"string"},"ExpirationDate":{"type":"string"},"Scope":{"type":"string","description":"Represents the scope of the created token. It is the client's responsability to manage this","default":"ordering","enum":["ordering","storage","subscription"]}}}}}} ``` ## The CreateEesTokenResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CreateEesTokenResponse":{"type":"object","required":["Results"],"properties":{"Results":{"type":"object","required":["Token"],"properties":{"Token":{"type":"string"}}}}}}}} ``` ## The CancelDealResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CancelDealResponse":{"type":"object","properties":{"AssistedSaleCancelTime":{"type":"string","description":"Schedules cancelation","enum":["TODAY_END_OF_DAY","END_OF_BILLING_CYCLE"]},"AssistedSaleRefunds":{"type":"array","items":{"type":"object","required":["RefundCurrency","RefundAmount","Refunded"],"properties":{"RefundCurrency":{"type":"string"},"RefundId":{"type":"integer"},"RefundAmount":{"type":"number"},"Refunded":{"type":"boolean"},"RefundFailReason":{"type":"string"}}}}},"description":""}}}} ``` ## The CancelDealErrorResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"CancelDealErrorResponse":{"title":"CancelDealErrorResponse","type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The product\_BundledProducts object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"product_BundledProducts":{"type":"object","properties":{"ProductId":{"type":"string","description":"Unique, system-generated product ID"},"ProductCode":{"type":"string","description":"Editable product code that you control"}}}}}} ``` ## The GetEligibleCampaignsResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"GetEligibleCampaignsResponse":{"type":"object","properties":{"AvailableCancellationReasons":{"type":"object","additionalProperties":{"type":"string"}},"Campaigns":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"DefaultMessage":{"type":"string"},"CancellationReasonRequired":{"type":"boolean"},"OfferPause":{"type":"boolean"},"OfferDiscount":{"type":"object","nullable":true,"properties":{"Message":{"type":"string"},"Discount":{"type":"number","format":"double"},"BillingCycles":{"type":"integer"}}}}}}}}}}} ``` ## The UpdatePartnerRequest object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"UpdatePartnerRequest":{"type":"object","properties":{"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"PricingConfigurations":{"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"Default":{"type":"boolean"},"PricingSchema":{"type":"string"},"PriceType":{"type":"string"},"DefaultCurrency":{"type":"string"},"Prices":{"type":"object","properties":{"Regular":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"},"MinQuantity":{"type":"string"},"MaxQuantity":{"type":"string"},"OptionCodes":{"type":"array","items":{"type":"string"}}}}},"Renewal":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"},"MinQuantity":{"type":"string"},"MaxQuantity":{"type":"string"}}}}}}}}}}}}} ``` ## The ResellerSearchResponse object ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"components":{"schemas":{"ResellerSearchResponse":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Reseller"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"Reseller":{"type":"object","properties":{"ResellerCode":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"Address":{"type":"string"},"State":{"type":"string"},"PostalCode":{"type":"string"},"Phone":{"type":"string"},"Country":{"type":"string"},"Fax":{"type":"string"},"PartnerCode":{"type":"string"}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.2checkout.com/api-reference/reference/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.