Skip to content

Commit ef42e4e

Browse files
committed
021_product_exchange.md: Start REST API ToC, sort routes
1 parent c226798 commit ef42e4e

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

docs/trainings/commerce/pim/021_product_exchange.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,95 @@ php bin/console ibexa:migrations:generate \
4747
--siteaccess=admin;
4848
```
4949

50+
TODO: What about product migration limitation, and product variant migration inexistence?
51+
5052
## REST API
5153

54+
Thanks to REST API, [[= product_name =]]'s PIM can be shared with other applications.
55+
56+
### Attribute groups and attributes
57+
58+
| CRUD action | Method verb | Route |
59+
|-------------|-------------|----------------------------------------|
60+
| Create | POST | /product/catalog/attribute_groups |
61+
| Read | GET | /product/catalog/attribute_groups/{id} |
62+
| Update | PATCH | /product/catalog/attribute_groups/{id} |
63+
| Delete | DELETE | /product/catalog/attribute_groups/{id} |
64+
65+
TODO: GET /product/catalog/attribute_types
66+
TODO: GET /product/catalog/attribute_types/{identifier}
67+
68+
TODO: DELETE /product/catalog/attribute_groups/translation/{id}/{languageCode}
69+
70+
| CRUD action | Method verb | Route |
71+
|-------------|-------------|---------------------------------------------|
72+
| Create | POST | /product/catalog/attributes |
73+
| Read | POST | /product/catalog/attributes/view |
74+
| Read | GET | /product/catalog/attributes/{id} |
75+
| Update | PATCH | /product/catalog/attributes/{id}/{group_id} |
76+
| Delete | DELETE | /product/catalog/attributes/{id} |
77+
78+
TODO: DELETE /product/catalog/attributes/translation/{id}/{languageCode}
79+
80+
### Product types
81+
82+
| CRUD action | Method verb | Route |
83+
|-------------|-------------|-----------------------------------------------------|
84+
| Create | POST | /product/catalog/product_types |
85+
| Read | GET | /product/catalog/product_types/{id} |
86+
| Read | GET | /product/catalog/product_types/is_used/{identifier} |
87+
| Read | POST | /product/catalog/product_types/view |
88+
| Update | PATCH | /product/catalog/product_types/{id} |
89+
| Delete | DELETE | /product/catalog/product_types/{id} |
90+
91+
### Product and product variants
92+
93+
| CRUD action | Method verb | Route |
94+
|-------------|-------------|------------------------------------------------------|
95+
| Create | POST | /product/catalog/products/{productTypeIdentifier} |
96+
| Read | GET | /product/catalog/products/{code} |
97+
| Read | POST | /product/catalog/products/view |
98+
| Read | POST | /product/catalog/catalogs/{identifier}/products/view |
99+
| Update | PATCH | /product/catalog/products/{code} |
100+
| Delete | DELETE | /product/catalog/products/{identifier} |
101+
102+
| CRUD action | Method verb | Route |
103+
|-------------|-------------|--------------------------------------------------------------|
104+
| Create | POST | /product/catalog/product_variants/{baseProductCode} |
105+
| Create | POST | /product/catalog/product_variants/generate/{baseProductCode} |
106+
| Read | GET | /product/catalog/product_variant/{code} |
107+
| Read | POST | /product/catalog/product_variants/view/{baseProductCode} |
108+
| Update | PATCH | /product/catalog/product_variants/{code} |
109+
| Delete | DELETE | /product/catalog/product_variants/{code} |
110+
111+
#### Product assets
112+
52113
TODO
53114

115+
### Catalogs
116+
117+
| CRUD action | Method verb | Route |
118+
|-------------|-------------|---------------------------------------------|
119+
| Create | POST | /product/catalog/catalogs |
120+
| Create | POST | /product/catalog/catalogs/copy/{identifier} |
121+
| Read | GET | /product/catalog/catalogs/{identifier} |
122+
| Read | POST | /product/catalog/catalogs/view |
123+
| Update | PATCH | /product/catalog/catalogs/{identifier} |
124+
| Delete | DELETE | /product/catalog/catalogs/{identifier} |
125+
126+
### Categories
127+
128+
TODO
129+
130+
### TODO: Exercises
131+
54132
TODO: Exercise request through REST the bikes from "5 series"
55133
TODO: /product/catalog/catalogs/{identifier}/products/view
56134

57135
## PHP API
58136

137+
[[= product_name =]]'s PIM can be extended, accessed through custom controllers, command lines, or whatever you imagine, thanks to the PHP API.
138+
59139
There are several services to read or modify the product model, the products, and other product related features.
60140

61141
### Attribute groups and attributes

0 commit comments

Comments
 (0)