Sitecore API catalog/OrderCloud/Subscriptions

Subscriptions

Subscription orders allow users to set up recurring orders for products or services that are needed on a regular basis.

Operations

List subscriptions

Request

Security
OAuth2(Required scopes: FullAccessSubscriptionAdminSubscriptionReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""FromCompanyID""ToCompanyID""Interval"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ID""Interval""NextOrderDate""LastOrderDate""DateCreated""EndDate""FromCompanyID""FromUserID""ToCompanyID""!ID"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/subscriptions?search=string&searchOn=ID&sortBy=ID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(Subscription)
Example:
[
  {
    "ID": "",
    "Frequency": 0,
    "Interval": "Days",
    "NextOrderDate": "2018-01-01T00:00:00-06:00",
    "LastOrderDate": "2018-01-01T00:00:00-06:00",
    "NotificationDate": "2018-01-01T00:00:00-06:00",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "EndDate": "2018-01-01T00:00:00-06:00",
    "Active": false,
    "FromCompanyID": "",
    "FromUserID": "",
    "ToCompanyID": "",
    "Payment": { … },
    "BillingAddressID": "",
    "ShippingAddressID": "",
    "ProjectedSubtotal": 0,
    "xp": {}
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}