Skip to main content
GET
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
group
/
test
Error
A valid request URL is required to generate request examples
{
  "active": true,
  "environmentID": 123,
  "name": "<string>",
  "rank": 123,
  "siteID": 123,
  "tenantID": 123,
  "afterActionNone": {
    "environmentID": 123,
    "siteID": 123,
    "tenantID": 123,
    "actionID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "failoverAction": "LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED",
    "name": "<string>",
    "pathString": "<string>",
    "persisted": true,
    "restartAttempt": "START_AT_BEGINNING",
    "suggestionEventListeners": [
      {}
    ],
    "updated": "2023-11-07T05:31:56Z",
    "updaterUsername": "<string>",
    "userContext": {
      "environmentID": 123,
      "loaded": true,
      "pathString": "<string>",
      "siteID": 123,
      "siteService": {},
      "tenantID": 123,
      "tenantService": {
        "tenantAttributesCache": {},
        "tenantClient": {}
      }
    }
  },
  "afterActionPartial": {
    "environmentID": 123,
    "siteID": 123,
    "tenantID": 123,
    "actionID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "failoverAction": "LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED",
    "name": "<string>",
    "pathString": "<string>",
    "persisted": true,
    "restartAttempt": "START_AT_BEGINNING",
    "suggestionEventListeners": [
      {}
    ],
    "updated": "2023-11-07T05:31:56Z",
    "updaterUsername": "<string>",
    "userContext": {
      "environmentID": 123,
      "loaded": true,
      "pathString": "<string>",
      "siteID": 123,
      "siteService": {},
      "tenantID": 123,
      "tenantService": {
        "tenantAttributesCache": {},
        "tenantClient": {}
      }
    }
  },
  "created": "2023-11-07T05:31:56Z",
  "creatorUsername": "<string>",
  "description": "<string>",
  "excludedLocationsFromDefaultGroup": [
    123
  ],
  "filterLogicalGroups": [
    {
      "environmentID": 123,
      "logicalOperator": "AND",
      "orderIndex": 123,
      "siteID": 123,
      "tenantID": 123,
      "andOperator": true,
      "filterLogicalGroupID": 123,
      "groupID": 123,
      "orOperator": true,
      "parentOrderIndex": 123,
      "rootGroup": true
    }
  ],
  "filters": [
    {
      "booleanOperator": "filter.logic.equal",
      "dotDelimitedPropertyName": "<string>",
      "environmentID": 123,
      "name": "<string>",
      "siteID": 123,
      "tenantID": 123,
      "created": "2023-11-07T05:31:56Z",
      "creatorUsername": "<string>",
      "customAttributeName": "<string>",
      "dataPointExtensibleAttributeFQN": "<string>",
      "dataPointExtensibleAttributeName": "<string>",
      "dataPointExtensibleAttributeType": "<string>",
      "dataPointExtensibleFilter": true,
      "extensibleAttributeFQN": "<string>",
      "extensibleAttributeName": "<string>",
      "extensibleFilter": true,
      "filterID": 123,
      "filterLogicalGroupOrderIndex": 123,
      "filterUnit": {
        "dimension": {},
        "standardUnit": {
          "dimension": {}
        }
      },
      "inventoryBasedFilter": true,
      "itemBasedFilter": true,
      "locationBasedFilter": true,
      "orderIndex": 123,
      "orderLocationFilterEqualToLocationOrInventoryFilter": true,
      "pathString": "<string>",
      "persisted": true,
      "suggestionEventListeners": [
        {}
      ],
      "updated": "2023-11-07T05:31:56Z",
      "updaterUsername": "<string>",
      "userContext": {
        "environmentID": 123,
        "loaded": true,
        "pathString": "<string>",
        "siteID": 123,
        "siteService": {},
        "tenantID": 123,
        "tenantService": {
          "tenantAttributesCache": {},
          "tenantClient": {}
        }
      }
    }
  ],
  "fulfillmentLimit": {
    "durationType": "HOURS",
    "environmentID": 123,
    "fulfillmentLimit": 1,
    "fulfillmentType": "ORDERS",
    "siteID": 123,
    "tenantID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "fulfillmentLimitID": 123,
    "name": "<string>",
    "pathString": "<string>",
    "persisted": true,
    "updated": "2023-11-07T05:31:56Z",
    "updaterUsername": "<string>",
    "userContext": {
      "environmentID": 123,
      "loaded": true,
      "pathString": "<string>",
      "siteID": 123,
      "siteService": {},
      "tenantID": 123,
      "tenantService": {
        "tenantAttributesCache": {},
        "tenantClient": {}
      }
    }
  },
  "groupID": 123,
  "isDefaultGroup": true,
  "pathString": "<string>",
  "persisted": true,
  "rankedLocations": [
    {
      "locationCode": "<string>",
      "locationID": 123,
      "rank": 123
    }
  ],
  "sorts": [
    {
      "environmentID": 123,
      "siteID": 123,
      "sortingType": "RANK",
      "tenantID": 123,
      "created": "2023-11-07T05:31:56Z",
      "creatorUsername": "<string>",
      "descending": true,
      "locationSortID": 123,
      "name": "<string>",
      "pathString": "<string>",
      "persisted": true,
      "suggestionEventListeners": [
        {}
      ],
      "updated": "2023-11-07T05:31:56Z",
      "updaterUsername": "<string>",
      "userContext": {
        "environmentID": 123,
        "loaded": true,
        "pathString": "<string>",
        "siteID": 123,
        "siteService": {},
        "tenantID": 123,
        "tenantService": {
          "tenantAttributesCache": {},
          "tenantClient": {}
        }
      }
    }
  ],
  "suggestionEventListeners": [
    {}
  ],
  "updated": "2023-11-07T05:31:56Z",
  "updaterUsername": "<string>",
  "useRetailerExclusionList": true,
  "userContext": {
    "environmentID": 123,
    "loaded": true,
    "pathString": "<string>",
    "siteID": 123,
    "siteService": {},
    "tenantID": 123,
    "tenantService": {
      "tenantAttributesCache": {},
      "tenantClient": {}
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Response

OK

active
boolean
required
environmentID
integer<int32>
required
name
string
required
Required string length: 1 - 255
rank
integer<int32>
required
siteID
integer<int32>
required
tenantID
integer<int32>
required
afterActionNone
object
afterActionPartial
object
created
string<date-time>
creatorUsername
string
description
string
Maximum string length: 255
excludedLocationsFromDefaultGroup
integer<int32>[]
filterLogicalGroups
object[]
filters
object[]
fulfillmentLimit
object
groupID
integer<int32>
isDefaultGroup
boolean
pathString
string
persisted
boolean
rankedLocations
object[]
sorts
object[]
suggestionEventListeners
object[]
updated
string<date-time>
updaterUsername
string
useRetailerExclusionList
boolean
userContext
object