Sitecore OrderCloud Documentation

docs

Portal Login

Create a new subscription.

POST

/subscriptions

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccessSubscriptionAdmin

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---------

Create a new subscription.

POST

/subscriptions

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccessSubscriptionAdmin

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