You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key in the specified [Store](ctp:api:type:Store).
17520
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key in the specified [Store](ctp:api:type:Store).
17521
+
17521
17522
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
17522
17523
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
17523
17524
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
17524
17525
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
17525
17526
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
17526
-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
17527
+
17528
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
17529
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
17530
+
17531
+
Required access scopes:
17532
+
17533
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
17534
+
17535
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
17690
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
17691
+
17682
17692
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
17683
17693
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
17684
17694
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
17685
17695
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
17686
-
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `id` and the given Store, this endpoint returns the ProductProjection with tailored data.
17687
-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
17696
+
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
17697
+
17698
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
17699
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
17700
+
17701
+
Required access scopes:
17702
+
17703
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
17704
+
17705
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
17688
17706
parameters:
17689
17707
- name: staged
17690
17708
x-annotation-default: false
@@ -28429,9 +28447,16 @@ paths:
28429
28447
- "view_published_products:{projectKey}"
28430
28448
operationId: ByProjectKeyProductProjectionsGet
28431
28449
description: |-
28432
-
Use the Product Projections query endpoint to get the current or staged representations of Products.
28433
-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
28434
-
this endpoint only returns published (current) Product Projections.
28450
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of [Products](ctp:api:type:Product) by [query predicates](/../api/predicates/query).
28451
+
28452
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
28453
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
28454
+
28455
+
Required access scopes:
28456
+
28457
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
28458
+
28459
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
Gets the current or staged representation of a [Product](ctp:api:type:Product) found by Key.
28655
-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
28656
-
this endpoint only returns published (current) Product Projections.
28679
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key.
28680
+
28681
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
28682
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
28683
+
28684
+
Required access scopes:
28685
+
28686
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
28687
+
28688
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID. When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
29171
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID.
29172
+
29173
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
29174
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
29175
+
29176
+
Required access scopes:
29177
+
29178
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
29179
+
29180
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
29140
29181
parameters:
29141
29182
- name: staged
29142
29183
x-annotation-default: false
@@ -80874,8 +80915,7 @@ components:
80874
80915
x-annotation-package: "Cart"
80875
80916
x-annotation-enumDescriptions:
80876
80917
All: "Publishes a Product that causes the _staged_ projection of the Product to override
80877
-
the _current_ projection. If the Product is published for the first time, the
80878
-
_current_ projection is created. This is the default scope."
80918
+
the _current_ projection. This is the default scope."
80879
80919
Prices: "Publishes the Prices of the Product (only if the Product is already published).
80880
80920
All Product Variants' Prices in the _staged_ projection are published into the
80881
80921
_current_ projection with the same `id`. Prices in a _staged_ Product Variant
0 commit comments