Sitecore OrderCloud Documentation

docs

Portal login

Create or update a subscription.

PUT

/subscriptions/{subscriptionID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessSubscriptionAdmin

Parameters

NameTypeDescriptionPossible Values
subscriptionIDRequiredstringID of the subscription.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
FrequencyRequiredintegerint32------

IntervalRequiredstring------Days, Weeks, Months

NextOrderDateRequiredstringdate-time------

EndDatestringdate-time------
Activeboolean---------
FromCompanyIDstring---------

FromUserIDstring---------

ToCompanyIDstring---------

Paymentobject---------
BillingAddressIDstring---------
ShippingAddressIDstring---------
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Frequencyintegerint32------

Intervalstring------Days, Weeks, Months

NextOrderDatestringdate-time------

LastOrderDateRead Onlystringdate-time------
NotificationDateRead Onlystringdate-time------

DateCreatedRead Onlystringdate-time------
EndDatestringdate-time------
Activeboolean---------
FromCompanyIDstring---------

FromUserIDstring---------

ToCompanyIDstring---------

Paymentobject---------
BillingAddressIDstring---------
ShippingAddressIDstring---------
xpobject---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore