Sitecore OrderCloud Documentation

docs

Portal Login

Get a single subscription.

GET

/me/subscriptions/{subscriptionID}

200

Roles

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

FullAccessMeSubscriptionAdminShopper

Parameters

NameTypeDescriptionPossible Values
subscriptionIDRequiredstringID of the subscription.---

Response Body

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

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

NextOrderDatestringdate-time------

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

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

FromUserIDstring---------

ToCompanyIDstring---------

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

Get a single subscription.

GET

/me/subscriptions/{subscriptionID}

200

Roles

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

FullAccessMeSubscriptionAdminShopper

Parameters

NameTypeDescriptionPossible Values
subscriptionIDRequiredstringID of the subscription.---

Response Body

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

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

NextOrderDatestringdate-time------

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

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

FromUserIDstring---------

ToCompanyIDstring---------

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

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

Contact Us
Privacy Policy
Sitecore