Entities and methods to handle baskets and payments.
Entities and methods to handle baskets and payments.
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
The Subscription to create.
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
curl -i -X POST \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/CreateSubscription?createdBy=0&ipAddress=string' \ -H 'Content-Type: application/json' \ -d '{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ { "Id": 0, "LineNo": 0, "ParentLineNo": 0, "ProductId": 0, "PartNo": "string", "ManufacturerPartNo": "string", "Name": "string", "SubHeader": "string", "ThumbnailImage": "string", "FlagIdSeed": "string", "Type": 0, "PriceDisplay": 0, "Price": 0, "PriceOriginal": 0, "Cost": 0, "VatRate": 0, "Quantity": 0, "UOM": "string", "UOMCount": 0, "Comment": "string", "PriceListId": 0, "ReferId": 0, "ReferUrl": "string", "IsEditable": true, "IsDiscountable": true, "Info": [ { "TypeId": 0, "Value": "string", "Code": "string" } ], "OptionalItems": [ {} ], "OnHandValue": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "PromotionIdSeed": "string", "ImageKey": "string", "ManufacturerName": "string", "CategoryId": 0, "OnHand": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ { "Id": 0, "Value": "string", "Code": "string" } ] }, "OnHandSupplier": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ { "Id": 0, "Value": "string", "Code": "string" } ] }, "PriceRecommended": 0, "ManufacturerId": 0, "UniqueName": "string", "StatusId": 0, "StockDisplayBreakPoint": 0, "PriceCatalog": 0, "IsBuyable": true, "SubDescription": "string", "CategoryIdSeed": "string", "RecommendedQuantity": 0, "IsRecommendedQuantityFixed": true, "AppliedPromotions": [ { "Id": 0, "Name": "string", "DiscountCode": "string", "AppliedAmount": 0, "AppliedAmountIncVat": 0 } ], "RequirementPromotionIdSeed": "string", "IsSubscribable": true, "DescriptionHeader": "string", "IsPriceManual": true, "PriceStandard": 0, "EanCode": "string", "CostUnit": 0, "PriceDisplayIncVat": 0, "PriceListLocked": true, "PriceOriginalIncVat": 0, "PriceRecommendedIncVat": 0, "PriceCatalogIncVat": 0, "PriceStandardIncVat": 0 } ], "Info": [ { "TypeId": 0, "Value": "string", "Code": "string" } ], "Summary": { "Items": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Freigt": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Fees": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Total": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 } }, "AppliedPromotions": [ { "Id": 0, "Name": "string", "Header": "string", "ShortDescription": "string", "Description1": "string", "Description2": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "ImageKey": "string", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ { "Id": 0, "Type": 0, "Name": "string", "Description": "string", "Key": "string" } ], "ProductFilters": [ { "ManufacturerId": 0, "CategorySeed": "string", "TypeId": 0, "ProductId": 0, "VariantProductId": 0, "PartNo": "string", "PricelistId": 0, "FlagId": 0 } ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0 } ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { "Id": 0, "IsActive": true, "Frequency": { "Id": 0, "Value": "string", "Code": "string" }, "RecurValue": 0, "IsOnMonday": true, "IsOnTuesday": true, "IsOnWednesday": true, "IsOnThursday": true, "IsOnFriday": true, "IsOnSaturday": true, "IsOnSunday": true, "MonthlyDay": 0, "MonthlyInterval": { "Id": 0, "Value": "string", "Code": "string" }, "MonthlyIntervalValue": { "Id": 0, "Value": "string", "Code": "string" }, "TimeOfDay": "string" } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }'
Success
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { … } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }
curl -i -X POST \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/DeleteSubscription?subscriptionId=0&updatedBy=0'
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/GetSubscription?id=0'
Success
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { … } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/GetSubscriptionByBasket?basketId=0'
Success
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { … } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/GetSubscriptionScheduleData
{ "Frequencies": [ { … } ], "MonthlyIntervals": [ { … } ], "MonthlyIntervalValues": [ { … } ] }
The internal customer id of the customer. The id is used to fetch subscriptions for that customer.
Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListSubscriptions?customerId=0&statusSeed=string'
Success
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
Calculated date for next time an order will be created by this subscription
[ { "Id": 0, "Name": "string", "TemplateBasket": { … }, "Type": { … }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ … ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" } ]
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListSubscriptionStatus
[ { "Id": 0, "Value": "string", "Code": "string" } ]
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListSubscriptionTypes
[ { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" } ]
The internal id of the Subscription to activate. Only inactive Subscriptions can be purchased and the Subscription must have valid Schedules.
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
General: 'test'=true to enable tests. When 'test' is used no payments will be processed for real. Payments may interpret supplied values such as cardNumber or ssn to simulate failures. Not implemented. Klarna: 'sessionId'=id. Used to provide a sessionId to Klarna payments. Not implemented. Payex and Dibs. Supported values are 'returnUrl' and 'cancelUrl'. Values should point to where the payment service should go in case of success/failure.
curl -i -X POST \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/PurchaseSubscription?ipAddress=string&subscriptionId=0&userAgent=string' \ -H 'Content-Type: application/json' \ -d '[ { "Name": "string", "Value": "string" } ]'
Success
String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.
External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.
Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.
PSP specific data returned for the payment. See PSP documentation.
{ "Status": "string", "StatusDescription": "string", "BasketId": 0, "OrderNo": "string", "PaymentCode": "string", "PaymentReference": "string", "HostedPaymentPage": "string", "RedirectUrl": "string", "RedirectParameters": [ { … } ], "IsSyncronous": true, "PaymentServiceId": 0 }
A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
The subscription to update. Only the Name, StatusId, HoldUntilDate, StartDate and Schedules can be changed. StatusId can only be changed between Active and Paused.
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
curl -i -X POST \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateSubscription?updatedBy=0' \ -H 'Content-Type: application/json' \ -d '{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ { "Id": 0, "LineNo": 0, "ParentLineNo": 0, "ProductId": 0, "PartNo": "string", "ManufacturerPartNo": "string", "Name": "string", "SubHeader": "string", "ThumbnailImage": "string", "FlagIdSeed": "string", "Type": 0, "PriceDisplay": 0, "Price": 0, "PriceOriginal": 0, "Cost": 0, "VatRate": 0, "Quantity": 0, "UOM": "string", "UOMCount": 0, "Comment": "string", "PriceListId": 0, "ReferId": 0, "ReferUrl": "string", "IsEditable": true, "IsDiscountable": true, "Info": [ { "TypeId": 0, "Value": "string", "Code": "string" } ], "OptionalItems": [ {} ], "OnHandValue": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "PromotionIdSeed": "string", "ImageKey": "string", "ManufacturerName": "string", "CategoryId": 0, "OnHand": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ { "Id": 0, "Value": "string", "Code": "string" } ] }, "OnHandSupplier": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ { "Id": 0, "Value": "string", "Code": "string" } ] }, "PriceRecommended": 0, "ManufacturerId": 0, "UniqueName": "string", "StatusId": 0, "StockDisplayBreakPoint": 0, "PriceCatalog": 0, "IsBuyable": true, "SubDescription": "string", "CategoryIdSeed": "string", "RecommendedQuantity": 0, "IsRecommendedQuantityFixed": true, "AppliedPromotions": [ { "Id": 0, "Name": "string", "DiscountCode": "string", "AppliedAmount": 0, "AppliedAmountIncVat": 0 } ], "RequirementPromotionIdSeed": "string", "IsSubscribable": true, "DescriptionHeader": "string", "IsPriceManual": true, "PriceStandard": 0, "EanCode": "string", "CostUnit": 0, "PriceDisplayIncVat": 0, "PriceListLocked": true, "PriceOriginalIncVat": 0, "PriceRecommendedIncVat": 0, "PriceCatalogIncVat": 0, "PriceStandardIncVat": 0 } ], "Info": [ { "TypeId": 0, "Value": "string", "Code": "string" } ], "Summary": { "Items": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Freigt": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Fees": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Total": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 } }, "AppliedPromotions": [ { "Id": 0, "Name": "string", "Header": "string", "ShortDescription": "string", "Description1": "string", "Description2": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "ImageKey": "string", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ { "Id": 0, "Type": 0, "Name": "string", "Description": "string", "Key": "string" } ], "ProductFilters": [ { "ManufacturerId": 0, "CategorySeed": "string", "TypeId": 0, "ProductId": 0, "VariantProductId": 0, "PartNo": "string", "PricelistId": 0, "FlagId": 0 } ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0 } ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { "Id": 0, "IsActive": true, "Frequency": { "Id": 0, "Value": "string", "Code": "string" }, "RecurValue": 0, "IsOnMonday": true, "IsOnTuesday": true, "IsOnWednesday": true, "IsOnThursday": true, "IsOnFriday": true, "IsOnSaturday": true, "IsOnSunday": true, "MonthlyDay": 0, "MonthlyInterval": { "Id": 0, "Value": "string", "Code": "string" }, "MonthlyIntervalValue": { "Id": 0, "Value": "string", "Code": "string" }, "TimeOfDay": "string" } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }'
Success
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
{ "Id": 0, "Name": "string", "TemplateBasket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Type": { "Id": 0, "Code": "string", "Name": "string", "Description": "string", "EndDate": "2019-08-24T14:15:22Z" }, "StatusId": 0, "HoldUntilDate": "2019-08-24T14:15:22Z", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Schedules": [ { … } ], "HoldFromDate": "2019-08-24T14:15:22Z", "NextRun": "2019-08-24T14:15:22Z" }