commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Custom-object → Get CustomObject by Container and Key

AI-generated

Summary

Retrieve a specific custom object from commercetools by providing its container name and key.

Inputs

  • Container (required) — The container name in which the custom object is stored.
  • Key (required) — The unique key identifying the custom object within the container.
  • Filters — Optional query parameters such as 'expand' to include additional references in the response.

Output shape

a single record representing the matching custom object with its data and metadata as JSON

Returns a JSON object if found, otherwise an error is thrown or handled per node settings. Supports optional 'expand' query parameter for including expanded references.

Examples

Example 1: Get custom object using container 'myContainer' and key 'objectKey123'

Set Container to 'myContainer', Key to 'objectKey123'. Optionally add 'expand' filter to include referenced objects inline.

Links

Discussion