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 ID in the specified [Store](ctp:api:type:Store).
5967
+
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).
5968
+
5968
5969
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
5969
5970
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
5970
5971
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
5971
5972
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.
5972
-
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.
5973
-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
5973
+
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.
5974
+
5975
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
5976
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
5977
+
5978
+
Required access scopes:
5979
+
5980
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
5981
+
5982
+
- 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 key in the specified [Store](ctp:api:type:Store).
6015
+
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).
6016
+
6007
6017
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
6008
6018
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
6009
6019
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
6010
6020
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.
6011
6021
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.
6012
-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
6022
+
6023
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
6024
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
6025
+
6026
+
Required access scopes:
6027
+
6028
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
6029
+
6030
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
Use the Product Projections query endpoint to get the current or staged representations of Products.
9552
-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
9553
-
this endpoint only returns published (current) Product Projections.
9569
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of [Products](ctp:api:type:Product) by [query predicates](/../api/predicates/query).
9570
+
9571
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9572
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9573
+
9574
+
Required access scopes:
9575
+
9576
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9577
+
9578
+
- 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.
9607
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID.
9608
+
9609
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9610
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9611
+
9612
+
Required access scopes:
9613
+
9614
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9615
+
9616
+
- 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.
9614
-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
9615
-
this endpoint only returns published (current) Product Projections.
9647
+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key.
9648
+
9649
+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9650
+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9651
+
9652
+
Required access scopes:
9653
+
9654
+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9655
+
9656
+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
* <p><code>true</code> if the Product is published.</p>
22
+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Product/ProductCatalogDataBuilder.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ final class ProductCatalogDataBuilder implements Builder
45
45
private$hasStagedChanges;
46
46
47
47
/**
48
-
* <p><code>true</code> if the Product is published.</p>
48
+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Product/ProductCatalogDataModel.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ public function __construct(
60
60
}
61
61
62
62
/**
63
-
* <p><code>true</code> if the Product is published.</p>
63
+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Product/ProductDraft.php
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -162,7 +162,9 @@ public function getSearchKeywords();
162
162
publicfunctiongetState();
163
163
164
164
/**
165
-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
165
+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
166
+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
167
+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Product/ProductDraftBuilder.php
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -307,7 +307,9 @@ public function getState()
307
307
}
308
308
309
309
/**
310
-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
310
+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
311
+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
312
+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Product/ProductDraftModel.php
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -497,7 +497,9 @@ public function getState()
497
497
}
498
498
499
499
/**
500
-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
500
+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
501
+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
502
+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/ProductTailoring/ProductTailoring.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -114,15 +114,15 @@ public function getProduct();
114
114
publicfunctiongetPublished();
115
115
116
116
/**
117
-
* <p>Current (published) data of the ProductTailoring.</p>
117
+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
118
118
*
119
119
120
120
* @return null|ProductTailoringData
121
121
*/
122
122
publicfunctiongetCurrent();
123
123
124
124
/**
125
-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
125
+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/ProductTailoring/ProductTailoringBuilder.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -229,7 +229,7 @@ public function getPublished()
229
229
}
230
230
231
231
/**
232
-
* <p>Current (published) data of the ProductTailoring.</p>
232
+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
233
233
*
234
234
235
235
* @return null|ProductTailoringData
@@ -240,7 +240,7 @@ public function getCurrent()
240
240
}
241
241
242
242
/**
243
-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
243
+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/ProductTailoring/ProductTailoringModel.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -366,7 +366,7 @@ public function getPublished()
366
366
}
367
367
368
368
/**
369
-
* <p>Current (published) data of the ProductTailoring.</p>
369
+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
370
370
*
371
371
*
372
372
* @return null|ProductTailoringData
@@ -387,7 +387,7 @@ public function getCurrent()
387
387
}
388
388
389
389
/**
390
-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
390
+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
0 commit comments