Cart (1.0)
Download OpenAPI specification:Download
API to manage carts
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "productRecoId": "string",
- "products": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": null,
- "code": null,
- "discountExternalContext": null,
- "id": null,
- "localizedLabel": null,
- "status": null
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": null,
- "code": null,
- "discountExternalContext": null,
- "id": null,
- "localizedLabel": null,
- "status": null
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": null,
- "code": null,
- "discountExternalContext": null,
- "id": null,
- "localizedLabel": null,
- "status": null
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": null,
- "code": null,
- "discountExternalContext": null,
- "id": null,
- "localizedLabel": null,
- "status": null
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}
], - "promoteOneClickPayment": true,
- "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "renewalSource": true,
- "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
- "sentEmails": [
- {
- "abandonedCartEmail": true,
- "emailId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "emailTemplate": "email template",
- "error": "error message",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "type": "email type"
}
], - "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
- "storeHostname": "string",
- "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
- "subscriptionGeneration": 0,
- "subscriptionId": "string",
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "taxAuthority": "AVALARA",
- "taxTransactionId": "string",
- "taxTypes": [
- {
- "amount": 0.1,
- "rate": 0.1,
- "taxName": "string"
}
], - "totalAmount": 0.1,
- "updateDate": "2019-08-24T14:15:22Z",
- "useStrikeThroughPrice": true,
- "userAgent": "string",
- "vatNumber": "string",
- "vouchers": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "vouchersTotalAmount": 0.1,
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
], - "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Create a cart with PrivateCartInput content in the request body
Authorizations:
Request Body schema: application/jsonrequired
Subscription Id | string |
billingPlanId | string |
billingPlanPeriod | string |
blockDiscounts | boolean Block discounts on this cart |
object (BuyerBehavior) Buyer behavior | |
catalogId | string Catalog ID |
checkoutUrl | string Full URL of cart |
object (ConsentFlags) Consent flags | |
country required | string Country of cart |
discounts | Array of strings List of signed discounts |
object (EndUserPut) End-user who owns this cart | |
enduserId | string |
externalContext | string External context |
object (Flags) Set of customer specific flags | |
forcedCurrency | string Currency forced by end user |
hideCrossSell | boolean Default: false Define if we display cross sell recommendation |
hideUpSell | boolean Default: false Define if we display upsell recommendation |
initialOrderId | string Deprecated |
ip | string Cart IP |
keepNonRecurringPaymentMethods | boolean All payment methods are needed for the subscription shopping cart |
locale required | string Locale of cart |
marketingCampaignNames | Array of strings List of marketing campaign name |
onPaymentClickRedirectUrl | string redirection url once payment page is closed |
partialPaymentAmount | number <double> |
paymentExternalContext | string |
paymentMethod | string payment method used by the end-user |
productRecoId | string Product recommendation id |
object | |
Array of objects (Remitted) List of remitteds | |
salesFlags | Array of strings List of sales flags |
scenario | string To be able to display different elements in the order workflow |
source | string Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE" Source |
storeHostname | string Hostname of store |
storeId required | string Reference ID of the store service |
subscriptionGeneration | integer <int32> subscription generation to use to get the public product. |
subscriptionSubSource | string Enum: "TRIAL_CONVERSION" "RENEWAL" Purchase's sub source |
useStrikeThroughPrice | boolean use strike through price |
userAgent | string User-Agent |
required | Array of objects (ProductInput) unique list of products or signed product in the cart with its quantity and price function parameters |
Responses
Request samples
- Payload
{- "Subscription Id": "string",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "catalogId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "discounts": [
- "string"
], - "endUser": {
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "validVatNumber": true,
- "zipCode": "12345"
}, - "enduserId": "string",
- "externalContext": "my external context",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "initialOrderId": "string",
- "ip": "127.0.0.1",
- "keepNonRecurringPaymentMethods": true,
- "locale": "fr-FR",
- "marketingCampaignNames": [
- "21c6e727-3df5-45c1-9872-66c6af3c5e61"
], - "partialPaymentAmount": 0.1,
- "paymentExternalContext": "string",
- "paymentMethod": "string",
- "productRecoId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
- "products": {
- "property1": {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}, - "property2": {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
}, - "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "source": "SUBSCRIPTION",
- "storeHostname": "storename.mydomain.fr",
- "storeId": "string",
- "subscriptionGeneration": 0,
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "useStrikeThroughPrice": true,
- "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 Safari/535.1",
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
]
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "productRecoId": "string",
- "products": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}
], - "promoteOneClickPayment": true,
- "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "renewalSource": true,
- "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
- "sentEmails": [
- {
- "abandonedCartEmail": true,
- "emailId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "emailTemplate": "email template",
- "error": "error message",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "type": "email type"
}
], - "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
- "storeHostname": "string",
- "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
- "subscriptionGeneration": 0,
- "subscriptionId": "string",
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "taxAuthority": "AVALARA",
- "taxTransactionId": "string",
- "taxTypes": [
- {
- "amount": 0.1,
- "rate": 0.1,
- "taxName": "string"
}
], - "totalAmount": 0.1,
- "updateDate": "2019-08-24T14:15:22Z",
- "useStrikeThroughPrice": true,
- "userAgent": "string",
- "vatNumber": "string",
- "vouchers": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "vouchersTotalAmount": 0.1,
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
], - "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
Create checkout
Create cart with products which are not in the actual catalog, will create new catalog and set the id of these products with created catalog as prefix
Authorizations:
Request Body schema: application/jsonrequired
required | object (PrivateCartInput) |
required | object (FullCatalog) |
Responses
Request samples
- Payload
{- "cart": {
- "Subscription Id": "string",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "catalogId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "discounts": [
- "string"
], - "endUser": {
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "validVatNumber": true,
- "zipCode": "12345"
}, - "enduserId": "string",
- "externalContext": "my external context",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "initialOrderId": "string",
- "ip": "127.0.0.1",
- "keepNonRecurringPaymentMethods": true,
- "locale": "fr-FR",
- "marketingCampaignNames": [
- "21c6e727-3df5-45c1-9872-66c6af3c5e61"
], - "partialPaymentAmount": 0.1,
- "paymentExternalContext": "string",
- "paymentMethod": "string",
- "productRecoId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
- "products": {
- "property1": {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}, - "property2": {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
}, - "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "source": "SUBSCRIPTION",
- "storeHostname": "storename.mydomain.fr",
- "storeId": "string",
- "subscriptionGeneration": 0,
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "useStrikeThroughPrice": true,
- "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 Safari/535.1",
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
]
}, - "fullCatalog": {
- "catalog": {
- "customerId": "string",
- "endDate": "2019-08-24T14:15:22Z",
- "singleUse": true,
- "status": "string"
}, - "locale": "string",
- "storeId": "string"
}
}
Response samples
- 200
- 201
- 400
- 401
- 403
- 500
{- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "productRecoId": "string",
- "products": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}
], - "promoteOneClickPayment": true,
- "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "renewalSource": true,
- "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
- "sentEmails": [
- {
- "abandonedCartEmail": true,
- "emailId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "emailTemplate": "email template",
- "error": "error message",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "type": "email type"
}
], - "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
- "storeHostname": "string",
- "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
- "subscriptionGeneration": 0,
- "subscriptionId": "string",
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "taxAuthority": "AVALARA",
- "taxTransactionId": "string",
- "taxTypes": [
- {
- "amount": 0.1,
- "rate": 0.1,
- "taxName": "string"
}
], - "totalAmount": 0.1,
- "updateDate": "2019-08-24T14:15:22Z",
- "useStrikeThroughPrice": true,
- "userAgent": "string",
- "vatNumber": "string",
- "vouchers": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "vouchersTotalAmount": 0.1,
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
], - "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
Create a mid term upgrade
Create a Cart with a mid term upgrade for a subscription
Authorizations:
Request Body schema: application/jsonrequired
externalContext | string External context |
subscriptionId required | string |
required | object (ProductInput) |
Responses
Request samples
- Payload
{- "externalContext": "string",
- "subscriptionId": "string",
- "wantedProduct": {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "productRecoId": "string",
- "products": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}
], - "promoteOneClickPayment": true,
- "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "renewalSource": true,
- "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
- "sentEmails": [
- {
- "abandonedCartEmail": true,
- "emailId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "emailTemplate": "email template",
- "error": "error message",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "type": "email type"
}
], - "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
- "storeHostname": "string",
- "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
- "subscriptionGeneration": 0,
- "subscriptionId": "string",
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "taxAuthority": "AVALARA",
- "taxTransactionId": "string",
- "taxTypes": [
- {
- "amount": 0.1,
- "rate": 0.1,
- "taxName": "string"
}
], - "totalAmount": 0.1,
- "updateDate": "2019-08-24T14:15:22Z",
- "useStrikeThroughPrice": true,
- "userAgent": "string",
- "vatNumber": "string",
- "vouchers": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "vouchersTotalAmount": 0.1,
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
], - "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create a Subscription Offer
Create a Cart with a discounted offer for a subscription
Authorizations:
Request Body schema: application/jsonrequired
discountCode | string |
externalContext | string |
subscriptionId required | string |
useStrikeThroughPrice | boolean |
Responses
Request samples
- Payload
{- "discountCode": "string",
- "externalContext": "string",
- "subscriptionId": "string",
- "useStrikeThroughPrice": true
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "cartId": "string",
- "customerId": "string",
- "externalContext": "string",
- "offerSubSource": "string",
- "product": {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}, - "source": "string",
- "storeId": "string",
- "subscriptionId": "string",
- "totalAmount": 0.1,
- "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "productRecoId": "string",
- "products": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "my business segment",
- "codeName": "my code name",
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "customerId": "65fc962c-5039-11eb-ae93-0242ac130002",
- "defaultCurrency": "EUR",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "durationUntilTrialEnd": 7,
- "existingLicenseId": "string",
- "externalContext": "external context",
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "fulfillment template name",
- "fullPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "id": "2f06e154-5039-11eb-ae93-0242ac130002",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1 YEAR",
- "lifeTimeUnit": "year",
- "lifeTimeValue": "1",
- "marketingCampaignId": "string",
- "name": "product name",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "priceFunctionParameters": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "internal description",
- "label": "label",
- "max": 10,
- "min": 1,
- "pattern": "string",
- "type": "type"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "priceSource": "INTERNAL",
- "publisherRefId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "quantity": 1,
- "quantityMaxReached": false,
- "renewingPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "signedProduct": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "subProducts": [
- { }
], - "subscriptionProduct": true,
- "subscriptionTemplate": "subscription template name",
- "taxCode": "tax code",
- "taxExempt": true,
- "trial": false,
- "type": "string",
- "unitPrice": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",
- "discountId": "85a2cfd6-510c-11eb-ae93-0242ac130002",
- "discountLabel": "Label example",
- "discountRate": 0.35,
- "discountedGrossPrice": 28.44,
- "discountedGrossPriceWithoutVoucher": 85.32,
- "discountedNetPrice": 26.4,
- "discountedNetPriceWithoutVoucher": 79.2,
- "grossPriceDiscountAmount": 15.31,
- "netPriceDiscountAmount": 14.22,
- "vatDiscountAmount": 2.04,
- "voucher": {
- "discounts": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "totalAmount": 60
}
}, - "grossMsrp": 15.42,
- "grossPrice": 9.99,
- "initialGrossPrice": 12.42,
- "initialNetPrice": 10.39,
- "initialVatAmount": 1.72,
- "mandateValue": 10.55,
- "marketingCampaignId": "string",
- "netMsrp": 9.4,
- "netPrice": 8.4,
- "remotePrice": {
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "strikeThroughPrice": 1,
- "vatAmount": 1.59,
- "vatAmountMsrp": 1.8,
- "vatIncluded": true,
- "vatRate": 0.19
}, - "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variablesDetails": {
- "property1": {
- "desc": "string",
- "label": "string",
- "value": { }
}, - "property2": {
- "desc": "string",
- "label": "string",
- "value": { }
}
}
}
], - "promoteOneClickPayment": true,
- "remitteds": [
- {
- "id": "string",
- "remittanceAmount": 0.1,
- "remittanceRate": 0
}
], - "renewalSource": true,
- "salesFlags": [
- "string"
], - "scenario": "acquisition",
- "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
- "sentEmails": [
- {
- "abandonedCartEmail": true,
- "emailId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "emailTemplate": "email template",
- "error": "error message",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "type": "email type"
}
], - "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
- "storeHostname": "string",
- "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
- "subscriptionGeneration": 0,
- "subscriptionId": "string",
- "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
- "taxAuthority": "AVALARA",
- "taxTransactionId": "string",
- "taxTypes": [
- {
- "amount": 0.1,
- "rate": 0.1,
- "taxName": "string"
}
], - "totalAmount": 0.1,
- "updateDate": "2019-08-24T14:15:22Z",
- "useStrikeThroughPrice": true,
- "userAgent": "string",
- "vatNumber": "string",
- "vouchers": [
- {
- "amount": 5,
- "code": "MYVOUCHERCODE",
- "discountExternalContext": "string",
- "id": "9a08c138-510c-11eb-ae93-0242ac130002",
- "localizedLabel": "my localized voucher label",
- "status": "APPLIED"
}
], - "vouchersTotalAmount": 0.1,
- "wantedProducts": [
- {
- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
], - "warnings": [
- {
- "code": "NOT_VALID",
- "field": "string",
- "message": "string",
- "type": "ADDITIONAL_FIELD_PER_COUNTRY"
}
]
}
Update products in cart
Update products for the given cart id
Authorizations:
path Parameters
id required | string Cart id |
query Parameters
productRecommendationId | string Product recommendation rule id |
version | integer <int64> version |
dryRun | boolean Determine if the operation will take effect in the database, if dryRun is true, cart will not be updated |
reason | string reason of request |
Request Body schema: application/jsonrequired
crossSellBy | string Product to cross-sell by another product |
currentExpirationDate | string Current expiration date |
object (DiscountPlan) Optional discount plan on a product | |
discountPlanIgnorePurchaseDiscount | boolean |
discountPlanStep | integer <int32> |
discountPlanTag | string |
durationUntilTrialEnd | integer <int32> [ 0 .. 3 ] Number of days before the end of trial reminder |
forcedBy | string Product to force by another product |
id required | string Product ID |
licenseId | string License id |
marketingCampaignId | string marketing campaign id use on the product |
nextExpirationDate | string Next expiration date |
parentId | string Product parent ID |
previousLineItemId | string Previous line item ID |
object Product parameters | |
quantity | integer <int32> Product quantity |
quantityMaxReached | boolean Indicator if a product quantity can not be increased (uses for the gift products in the marketing campaigns) |
remotePrice | boolean |
subscriptionTemplate | string |
trial | boolean Indicator if it is a product trial |
upSellBy | string Product to upsell by another product |
Responses
Request samples
- Payload
{- "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "currentExpirationDate": "1712906328000",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountPlanIgnorePurchaseDiscount": true,
- "discountPlanStep": 0,
- "discountPlanTag": "string",
- "durationUntilTrialEnd": 7,
- "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
- "marketingCampaignId": "string",
- "nextExpirationDate": "1712906328000",
- "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
- "priceFunctionParameters": {
- "property1": "string",
- "property2": "string"
}, - "quantity": 2,
- "quantityMaxReached": false,
- "remotePrice": true,
- "subscriptionTemplate": "string",
- "trial": false,
- "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "availableCurrencies": "[EUR,USD]",
- "billingPlanId": "string",
- "billingPlanPeriod": "string",
- "blockDiscounts": true,
- "buyerBehavior": {
- "abandonedCart": true,
- "renewal": true,
- "retainBuyer": true
}, - "cancelPeriod": 0,
- "cartIp": "string",
- "catalogId": "string",
- "checkoutUrl": "string",
- "consentFlags": {
- "newsletterOptin": true
}, - "country": "FR",
- "createDate": "2019-08-24T14:15:22Z",
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "customerId": "string",
- "dbVersion": 0,
- "discounts": [
- "string"
], - "discountsStatus": [
- {
- "discount": "string",
- "discountLabel": "string",
- "status": "string"
}
], - "ecommerceToken": "string",
- "eligibleFeatures": {
- "abandoned": true
}, - "endUser": {
- "addressError": true,
- "birthDate": "2019-08-24T14:15:22Z",
- "city": "city name",
- "company": {
- "apeCode": "4791B",
- "cnpj": "00.000.000 / 0001-00",
- "companyName": "My company name",
- "fullRegistrationNumber": "362 521 879 00034",
- "registrationNumber": "362 521 879",
- "validVatNumber": true,
- "vatNumber": "FR12345678901"
}, - "consumerType": "company",
- "country": "FR",
- "cpf": "string",
- "customerId": "string",
- "encryptedEmail": "string",
- "firstName": "first name",
- "id": "aa727f80-510e-11eb-ae93-0242ac130002",
- "lastName": "last name",
- "locale": "fr-FR",
- "maskedEmail": false,
- "phone": "0123456789",
- "recipientCode": "0000000000",
- "region": "FR-YT",
- "resellerTaxExemptionEligible": true,
- "storeId": "string",
- "storeRoute": {
- "builtHostname": "string",
- "fullUrl": "string",
- "hostname": "string",
- "pathPrefix": "string"
}, - "streetAddress": "Street name",
- "taxExemptionChecked": true,
- "taxExemptionEligible": false,
- "title": "MR",
- "type": "RESELLER",
- "wallet": {
- "creditCards": [
- {
- "bin": "411111",
- "expirationDate": "07/2025",
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
], - "paypals": [
- {
- "id": "string",
- "paymentMethodType": "string",
- "type": "string"
}
]
}, - "zipCode": "12345"
}, - "endUserDiscountAmountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "endUserDiscounts": [
- {
- "amountByCurrency": {
- "property1": 0.1,
- "property2": 0.1
}, - "codes": [
- {
- "discountCode": "string"
}
], - "endDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "localizedLabels": {
- "property1": "string",
- "property2": "string"
}, - "startDate": "2019-08-24T14:15:22Z"
}
], - "enduserId": "string",
- "externalContext": "string",
- "flags": {
- "productSubstituted": true
}, - "forcedCurrency": "EUR",
- "hideCrossSell": false,
- "hideUpSell": false,
- "id": "string",
- "installments": [
- 0
], - "keepNonRecurringPaymentMethods": true,
- "lastUpdateReason": "string",
- "layout": "subscription | trial",
- "locale": "fr-FR",
- "manualUpdateDate": "2019-08-24T14:15:22Z",
- "marketingCampaignNames": [
- "string"
], - "maxPartialPaymentAmount": 0.1,
- "maxPaymentsParts": 0,
- "minPartialPaymentAmount": 0.1,
- "modelVersion": "string",
- "notReadyForOrderCauseMessage": "string",
- "offerSubSource": "RESUME | SUSPEND",
- "onPaymentClickRedirectUrl": "string",
- "orderId": "string",
- "paymentMethod": "credit_card",
- "paymentTypes": [
- {
- "category": "string",
- "id": "string",
- "registrable": true,
- "role": "string"
}
], - "piiDataSecureToken": "string",
- "price": {
- "currency": "EUR",
- "discountedPrice": {
- "allDiscountsApplied": [
- {
- "discountAmount": 0.1,
- "discountCode": "string",
- "discountId": "string",
- "discountRate": 0.1,
- "discountedGrossPrice": 0.1,
- "discountedNetPrice": 0.1,
- "grossPrice": 0.1,
- "grossPriceDiscountAmount": 0.1,
- "model": "string",
- "netPrice": 0.1,
- "netPriceDiscountAmount": 0.1,
- "vatDiscountAmount": 0.1
}
], - "cumulatedDiscountRate": 0.35,
- "discountCode": "MYDISCOUNTCODE",
- "discountExternalContext": "external context",