Sitecore API catalog/OrderCloud/Incrementors

Incrementors

Incrementors add an atomically incremented number to your object IDs. For example, using "aprefix-{myIncrementorID}" results in an order ID of "aprefix-10010".

Operations

List incrementors

Request

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

Responses

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