Sitecore API catalog/OrderCloud/Cost centers

Cost centers

Cost centers are used to allocate organizational expenditures. Customers may have different names for this, such as "allocation codes" or "charge back codes", but the purpose is to allocate an expense to a person or department in an organization. Cost centers can referenced on line items, but they do not influence any behavior in OrderCloud.

Operations

List cost centers

Request

Security
OAuth2(Required scopes: FullAccessCostCenterAdminCostCenterReader)
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""Description"
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}/costcenters?search=string&searchOn=ID&sortBy=Name&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(CostCenter)
Example:
[
  {
    "ID": "",
    "Name": "",
    "Description": "",
    "xp": {}
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}