Skip to content

Commit 5b94bbb

Browse files
authored
Merge pull request #652 from akeneo/CPM-724
CPM-724: Add Product Uuids endpoints
2 parents 85cd3d6 + 87cf215 commit 5b94bbb

File tree

39 files changed

+1788
-85
lines changed

39 files changed

+1788
-85
lines changed

content/concepts/asset-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1930,7 +1930,7 @@ Here are the steps to follow to link assets to your products:
19301930
2. Put this attribute within the [families](/concepts/catalog-structure.html#familiy) of the products you want to link your assets to.
19311931
3. Assign your assets to these products either:
19321932
- manually, in the `Assets` tab of the product form in the PIM UI,
1933-
- by API using the [product](/api-reference.html#patch_products) POST and PATCH endpoints by adding the asset codes in the asset collection data,
1933+
- by API using the [product](/api-reference.html#patch_products_uuid) POST and PATCH endpoints by adding the asset codes in the asset collection data,
19341934
- automatically thanks to the [product link rule](#focus-on-the-product-link-rule), detailed in the paragraph below.
19351935

19361936
::: info

content/concepts/products.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,21 @@ Below is the JSON standard format representing a product.
2626

2727
```json
2828
{
29-
"identifier": "1111111195",
29+
"uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5",
3030
"family": "clothing",
3131
"parent": "jack_brown",
3232
"categories": [
3333
"tshirts"
3434
],
3535
"enabled": true,
3636
"values": {
37+
"sku": [
38+
{
39+
"locale": null,
40+
"scope": null,
41+
"data": "1111111195"
42+
}
43+
],
3744
"ean": [
3845
{
3946
"locale": null,
@@ -138,7 +145,7 @@ Note that the `quality_scores` field is only available since the 5.0 and when th
138145
Note that the `completenesses` field is only available on SaaS platforms, and when the `with_completenesses` query parameter is set to `true`.
139146
:::
140147

141-
::: panel-link Want more details about the product resource? [Check its endpoints here!](/api-reference.html#Product)
148+
::: panel-link Want more details about the product resource? [Check its endpoints here!](/api-reference.html#Productuuid)
142149
:::
143150

144151
### Convert a variant product to a simple product

content/files/Akeneo PIM API.postman_collection.json

Lines changed: 487 additions & 0 deletions
Large diffs are not rendered by default.

content/files/your-very-first-collection.postman_collection.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@
2424
}
2525
],
2626
"url": {
27-
"raw": "{{url}}/api/rest/v1/products",
27+
"raw": "{{url}}/api/rest/v1/products-uuid",
2828
"host": [
2929
"{{url}}"
3030
],
3131
"path": [
3232
"api",
3333
"rest",
3434
"v1",
35-
"products"
35+
"products-uuid"
3636
]
3737
},
3838
"description": "This REST API request asks the PIM for its 100 first products."

content/getting-started/connect-the-pim-4x/step-2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ _In our example, as stated above, we know that every day, new products are creat
6262
In this step, you will need to find in our [REST API reference](/api-reference-index.html) the endpoints you need to achieve such a connection.
6363

6464
#### In this tutorial
65-
_For our example, you will need to create and update products in the PIM so we will mainly need this endpoint: [Patch](/api-reference.html#patch_products) on products._
65+
_For our example, you will need to create and update products in the PIM so we will mainly need this endpoint: [Patch](/api-reference.html#patch_products_uuid) on products._
6666

6767
### 5- Think about your architecture
6868
Choose the architecture you want for your connector. Indeed, you will have two options here:
@@ -81,7 +81,7 @@ _For our example, we choose the second option as there are little chances that y
8181
A crucial step. In most cases, you will need to manually map some PIM information with the data sent or received in or from the software you want to connect.
8282

8383
#### In this tutorial
84-
_For our example, here is the global orchestration of our connector. First, every evening, you will extract the list of products that were created/updated during the day, in an XML file. Then, your connector reads this file. ERP products are then transformed into PIM products, by mapping the ERP information with the right PIM attributes. Lastly, the connector sends the PIM products by using the [patch](/api-reference.html#patch_products) endpoint of our REST API._
84+
_For our example, here is the global orchestration of our connector. First, every evening, you will extract the list of products that were created/updated during the day, in an XML file. Then, your connector reads this file. ERP products are then transformed into PIM products, by mapping the ERP information with the right PIM attributes. Lastly, the connector sends the PIM products by using the [patch](/api-reference.html#patch_products_uuid) endpoint of our REST API._
8585

8686
## Some pro tips
8787

content/getting-started/connect-the-pim-old/step-1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ _In our example, as stated above, we know that every day, new products are creat
5858
In this step, you will need to find in our [REST API reference](/api-reference-index.html) the endpoints you need to achieve such a connection.
5959

6060
#### In this tutorial
61-
_For our example, you will need to create and update products in the PIM so we will mainly need this endpoint: [Patch](/api-reference.html#patch_products) on products._
61+
_For our example, you will need to create and update products in the PIM so we will mainly need this endpoint: [Patch](/api-reference.html#patch_products_uuid) on products._
6262

6363
### 5- Think about your architecture
6464
Choose the architecture you want for your connector. Indeed, you will have two options here:
@@ -77,7 +77,7 @@ _For our example, we choose the second option as there are little chances that y
7777
A crucial step. In most cases, you will need to manually map some PIM information with the data sent or received in or from the software you want to connect.
7878

7979
#### In this tutorial
80-
_For our example, here is the global orchestration of our connector. First, every evening, you will extract the list of products that were created/updated during the day, in an XML file. Then, your connector reads this file. ERP products are then transformed into PIM products, by mapping the ERP information with the right PIM attributes. Lastly, the connector sends the PIM products by using the [patch](/api-reference.html#patch_products) endpoint of our REST API._
80+
_For our example, here is the global orchestration of our connector. First, every evening, you will extract the list of products that were created/updated during the day, in an XML file. Then, your connector reads this file. ERP products are then transformed into PIM products, by mapping the ERP information with the right PIM attributes. Lastly, the connector sends the PIM products by using the [patch](/api-reference.html#patch_products_uuid) endpoint of our REST API._
8181

8282
## Some pro tips
8383

content/getting-started/synchronize-pim-products-6x/step-4.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ We recommend to you the following product filters:
1818
- by family codes (save to your storage in a **family_code_list** during [the second step](/getting-started/synchronize-pim-products-6x/step-2.html));
1919
- by enabled products (you probably don’t use not enabled products, don’t you?)
2020

21-
Another very important point is the **with_attribute_options**. When this option is activated, labels of attributes options will be returned in the response — and saves you from many extra API calls. More information [here](https://api.akeneo.com/api-reference.html#get_products).
21+
Another very important point is the **with_attribute_options**. When this option is activated, labels of attributes options will be returned in the response — and saves you from many extra API calls. More information [here](https://api.akeneo.com/api-reference.html#get_products_uuid).
2222

2323
::: tips
2424
Have a look at our [product filters](https://api.akeneo.com/documentation/filter.html#filter-on-product-properties): you may find other interesting ones.
2525
:::
2626

2727
So, what does our API call on products look like?
2828

29-
`GET /api/rest/v1/products?locales=locales&scope=your_channel_code&with_attribute_options=true&search={"family":[{"operator":"IN","value":family_code_list}],"enabled"[{"operator":"=","value":true}]}`
29+
`GET /api/rest/v1/products-uuid?locales=locales&scope=your_channel_code&with_attribute_options=true&search={"family":[{"operator":"IN","value":family_code_list}],"enabled"[{"operator":"=","value":true}]}`
3030

31-
Details of this call are [here](https://api.akeneo.com/api-reference.html#get_products).
31+
Details of this call are [here](https://api.akeneo.com/api-reference.html#get_products_uuid).
3232

3333
What is important in the response payload?
3434

content/getting-started/your-first-tutorial-4x/step-3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Alright! You're all set now. Let's launch this request.
1010
In the response area, you should get an answer similar to the one below.
1111
![Response area for authent request](/img/getting-started/authentication-response.png)
1212
4. Now, click on `Your very first request` in the `Collections` tab.
13-
5. You can see the request we are about to launch. It is using the endpoint referenced [here](/api-reference.html#get_products). We are going to ask your PIM to give us its first 100 products.
13+
5. You can see the request we are about to launch. It is using the endpoint referenced [here](/api-reference.html#get_products_uuid). We are going to ask your PIM to give us its first 100 products.
1414
![Your very first request](/img/getting-started/your-very-first-request.png)
1515
6. Are you ready? Hit the blue `Send` button.
1616
In the response area, you can see a list of 100 products in json format.

content/getting-started/your-first-tutorial-old/step-3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Alright! You're all set now. Let's launch this request.
1010
In the response area, you should get an answer similar to the one below.
1111
![Response area for authent request](/img/getting-started/authentication-response.png)
1212
4. Now, click on `Your very first request` in the `Collections` tab.
13-
5. You can see the request we are about to launch. It is using the endpoint referenced [here](/api-reference.html#get_products). We are going to ask your PIM to give us its first 100 products.
13+
5. You can see the request we are about to launch. It is using the endpoint referenced [here](/api-reference.html#get_products_uuid). We are going to ask your PIM to give us its first 100 products.
1414
![Your very first request](/img/getting-started/your-very-first-request.png)
1515
6. Are you ready? Hit the blue `Send` button.
1616
In the response area, you can see a list of 100 products in json format.

content/guides/translation-connection/step3-how-to-build-your-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ We suggest that you develop the first solution during the first iteration of you
181181
:::
182182

183183
:::tips
184-
Using the ["get a list of products"](https://api.akeneo.com/api-reference.html#get_products) API endpoint (with the correct filter), your App will retrieve a JSON structure of each localizable products.
184+
Using the ["get a list of products"](https://api.akeneo.com/api-reference.html#get_products_uuid) API endpoint (with the correct filter), your App will retrieve a JSON structure of each localizable products.
185185

186186
Then, with the help of the family code of these products, your App will be able to call the ["get the list of attributes"](https://api.akeneo.com/api-reference.html#get_attributes) API endpoint to retrieve each attribute type that composes this product family.
187187

0 commit comments

Comments
 (0)