Inventories REST API

Inventories REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/inventories/contract

Create object

post

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

application/json

Objects Grid Inventory Object

anyOptional

or

anyOptional

Responses

201

Successfully created the object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

409

Conflict, object already exists

application/json

429

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

post

/inventories

HTTPcURLJavaScriptPython

POST /inventories HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1085

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Retrieve Object

get

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to retrieve

Query parameters

langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

200

Successfully retrieved the object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal server error

application/json

get

/inventories/{id}

HTTPcURLJavaScriptPython

GET /inventories/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update Object

put

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

application/json

Objects Grid Inventory Object

anyOptional

or

anyOptional

Responses

200

Successfully updated the object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal server error

application/json

put

/inventories/{id}

HTTPcURLJavaScriptPython

PUT /inventories/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1085

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Patch Object

patch

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

application/json

Objects Grid Inventory Object

anyOptional

or

anyOptional

Responses

200

Successfully patched the object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal server error

application/json

patch

/inventories/{id}

HTTPcURLJavaScriptPython

PATCH /inventories/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1085

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

{
  "id": "text",
  "at_context": "https://schema.org",
  "at_type": "Inventory",
  "url": "https://example.com",
  "product": "https://example.com",
  "location": "https://example.com",
  "channel": "text",
  "availableQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "reservedQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "safetyStock": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "inboundQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "backorderQuantity": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "status": "text",
  "isInfinite": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2026-03-13T17:26:58.210Z",
    "createdBy": "text",
    "lastUpdatedAt": "2026-03-13T17:26:58.210Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete Object

delete

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to delete

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

200

Successfully deleted the object

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal server error

application/json

delete

/inventories/{id}

HTTPcURLJavaScriptPython

DELETE /inventories/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Query parameters

langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB

querystringOptional

Elastic Search Query DSL.

Example: { "query": { "match_all": {} } }

fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

200

Successfully listed the objects

application/json

400

Bad request

application/json

401

Unauthorized

application/json

429

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

get

/inventories

HTTPcURLJavaScriptPython

GET /inventories HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  null
]