Sitecore API catalog/OrderCloud/Spending accounts

Spending accounts

Spending accounts are funds assigned to users that can be used as a payment method on an order. These funds are generally used as corporate budget accounts or rewards dollars. They include parameters that control expiration, balance available, balance renewal, user access and overdraft.

Operations

List spending accounts

Request

Security
OAuth2(Required scopes: FullAccessSpendingAccountAdminSpendingAccountReader)
Path
buyerIDstringrequired

ID of the buyer.

Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"Name""ID""!Name""!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/buyers/{buyerID}/spendingaccounts?search=string&searchOn=ID&sortBy=Name&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(SpendingAccount)
Example:
[
  {
    "ID": "",
    "Name": "",
    "Balance": 0,
    "AllowAsPaymentMethod": false,
    "StartDate": "2018-01-01T00:00:00-06:00",
    "EndDate": "2018-01-01T00:00:00-06:00",
    "xp": {}
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}