Event Scope Configuration (Core)

Endpoints to create, update and read event scope configurations.

Create event scope config

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Create a new event scope configuration for inventory article availability changed events.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InventoryArticleAvailabilityChangedEventScopeForCreation

facilityGroupRefsstring[] · max: 5 · nullableOptional

Facility group references whose members are included in this scope. Omit or null for a global scope including all facilities.

facilityRefsstring[] · max: 50 · nullableOptional

Direct facility references to include in this scope. Omit or null for a global scope including all facilities.

keystring · max: 128Required

Unique key identifying this scope. Used to derive the URN.

statusstring · enumOptional

A scope config can be set to inactive instead of being deleted to temporarily disable emission. The maximum limit of 10 applies to both active and inactive scope configs.

Default: ACTIVEPossible values:

Responses

201

The created event scope configuration.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/configurations/eventscopes/inventoryarticleavailabilitychanged

HTTPcURLJavaScriptPython

POST /api/configurations/eventscopes/inventoryarticleavailabilitychanged HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "key": "text",
  "status": "ACTIVE"
}

{
  "created": "2026-06-06T02:49:43.271Z",
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "key": "text",
  "lastModified": "2026-06-06T02:49:43.271Z",
  "status": "ACTIVE",
  "version": 1
}

Get event scope config

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get an event scope configuration by ID or URN.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of scope you want to get. Also accepts key in urn format (e.g., urn:fft:eventScopeConfig:key:{your-key}).

Responses

200

The event scope configuration.

application/json

InventoryArticleAvailabilityChangedEventScope

createdstring · date-timeRequired

facilityGroupRefsstring[]Optional

facilityRefsstring[]Optional

idstringRequired

keystringRequired

lastModifiedstring · date-timeRequired

statusstring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id}

HTTPcURLJavaScriptPython

GET /api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-06-06T02:49:43.271Z",
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "key": "text",
  "lastModified": "2026-06-06T02:49:43.271Z",
  "status": "ACTIVE",
  "version": 1
}

Replace event scope config

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Replace an existing event scope configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of scope you want to get. Also accepts key in urn format (e.g., urn:fft:eventScopeConfig:key:{your-key}).

Body

application/json

InventoryArticleAvailabilityChangedEventScopeForReplace

facilityGroupRefsstring[] · max: 5 · nullableOptional

Facility group references whose members are included in this scope. Omit or null for a global scope including all facilities.

facilityRefsstring[] · max: 50 · nullableOptional

Direct facility references to include in this scope. Omit or null for a global scope including all facilities.

statusstring · enumOptional

A scope config can be set to inactive instead of being deleted to temporarily disable emission. The maximum limit of 10 applies to both active and inactive scope configs.

Possible values:

versionnumberRequired

Version for optimistic locking.

Responses

200

The updated event scope configuration.

application/json

InventoryArticleAvailabilityChangedEventScope

createdstring · date-timeRequired

facilityGroupRefsstring[]Optional

facilityRefsstring[]Optional

idstringRequired

keystringRequired

lastModifiedstring · date-timeRequired

statusstring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

put

/api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id}

HTTPcURLJavaScriptPython

PUT /api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "status": "ACTIVE",
  "version": 1
}

{
  "created": "2026-06-06T02:49:43.271Z",
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "key": "text",
  "lastModified": "2026-06-06T02:49:43.271Z",
  "status": "ACTIVE",
  "version": 1
}

Delete event scope config

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Delete an event scope configuration by ID or URN.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of scope you want to get. Also accepts key in urn format (e.g., urn:fft:eventScopeConfig:key:{your-key}).

Responses

200

The event scope configuration was deleted.

application/json

InventoryArticleAvailabilityChangedEventScope

createdstring · date-timeRequired

facilityGroupRefsstring[]Optional

facilityRefsstring[]Optional

idstringRequired

keystringRequired

lastModifiedstring · date-timeRequired

statusstring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id}

HTTPcURLJavaScriptPython

DELETE /api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-06-06T02:49:43.271Z",
  "facilityGroupRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "key": "text",
  "lastModified": "2026-06-06T02:49:43.271Z",
  "status": "ACTIVE",
  "version": 1
}

List event scope configs (search)

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Search for ScopedAvailabilityConfig

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ScopedAvailabilityConfigSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

ScopedAvailabilityConfigPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/configurations/eventscopes/inventoryarticleavailabilitychanged/search

HTTPcURLJavaScriptPython

POST /api/configurations/eventscopes/inventoryarticleavailabilitychanged/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1942

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityGroupRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "key": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ACTIVE",
              "in": [
                "ACTIVE"
              ],
              "notEq": "ACTIVE"
            }
          }
        ],
        "facilityGroupRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "key": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityGroupRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "key": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ACTIVE",
              "in": [
                "ACTIVE"
              ],
              "notEq": "ACTIVE"
            }
          }
        ],
        "status": {
          "eq": "ACTIVE",
          "in": [
            "ACTIVE"
          ],
          "notEq": "ACTIVE"
        }
      }
    ],
    "facilityGroupRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "facilityRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "key": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityGroupRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "key": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "status": {
          "eq": "ACTIVE",
          "in": [
            "ACTIVE"
          ],
          "notEq": "ACTIVE"
        }
      }
    ],
    "status": {
      "eq": "ACTIVE",
      "in": [
        "ACTIVE"
      ],
      "notEq": "ACTIVE"
    }
  },
  "size": 1,
  "sort": [
    {
      "id": "ASC",
      "key": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "scopedAvailabilityConfigs": [
    {
      "created": "2026-06-06T02:49:43.271Z",
      "facilityGroupRefs": [
        "text"
      ],
      "facilityRefs": [
        "text"
      ],
      "id": "text",
      "key": "text",
      "lastModified": "2026-06-06T02:49:43.271Z",
      "status": "ACTIVE",
      "version": 1
    }
  ],
  "total": 1
}