From 43aaafc68c72c09982bd9fa440f821aacf722eec Mon Sep 17 00:00:00 2001
From: Magdalena Sadowska <magdalena.sadowska@sylius.com>
Date: Tue, 5 Nov 2024 12:49:20 +0000
Subject: [PATCH] GITBOOK: Export Sylius documentation

---
 docs/.gitbook/assets/sylius_shipment.webp   | Bin 0 -> 3408 bytes
 docs/the-book/carts-and-orders/shipments.md | 114 +++++++++++++++++++-
 2 files changed, 113 insertions(+), 1 deletion(-)
 create mode 100644 docs/.gitbook/assets/sylius_shipment.webp

diff --git a/docs/.gitbook/assets/sylius_shipment.webp b/docs/.gitbook/assets/sylius_shipment.webp
new file mode 100644
index 0000000000000000000000000000000000000000..6f1aada4bd82731332daedd76e2a8b3ec7f57787
GIT binary patch
literal 3408
zcmZ8jc{~$<`<`oa&k<vaiQG+=u-syfN-Q&CBX=dY+&Pn@DOVyna+Eoia$A@y%CTg~
zooh*s+!Xuv>-YQP`}zI%d_K?nzR&x9o<H6PZHhvf@Bjc<BLfR-3ymvUf3flmC7dsx
zqL5Z>eVrY^X!1#Av~x9&Ir5pJi>v|1T(%8SgGk*8lQig6R>$;66PLpG5LwYWLUGTB
zy*|bf_K+z`;smvgUFJ=ckf$R^R)fMOz7Yi>!zOiG87hMZb`$f+$UP2$b{+{z^OhSK
zs*FnBe61=^_#qJ&T8RJi!a{a>xY(x4Vquc7CNlMTVl}ewC+Ws3bUYfkEax$S$~owm
z4toeYEdxV1RovBa=cml6<dF@dx1Yw;u3E0hq@&d{GE(eB_FDCo0wPv{M-DPE+eKhg
zR-<hRfeE!VX;%_=6BlYJugr`T6xnijqDpMEuCloPSPPg5EOKa<QVmbMi5BnJWH556
z)ZzuMt0{`Gf?7@iR=&@XCLU6zX}MI3ceD%BRps=3>8&s(Z>8g{NCs0*D<JW)@*fVA
z($dzp8-p<Xdz@Ioe9?;b;vZ_i1ph>bd-iNI#>3}3mOFGD4leKPai@i`t^0r5Xq^r)
z%Z*WYc^+;zuo7N!d=)cuZ29)bCn3utMeG=+TzlYt<YiV{5r}~%PDuO#|9$fH2-7aP
z9y{9gkgem`=FrUTpTnl|hHDDVIv=ZKerR=-UBvWv-GZ&W)0s*H6TLAk&1ydI_yQtS
zgIT55wLZi8lcGF7NAK*TN6%{$ZYu`j@-L$!G6c5oHm199aDwOtPhMemD3%e|g@`a>
z=u5mZ5$s$ecssN_=kg2EgA-PEwRO|R2RO{y84!=U_m~ExqbviYJjwa>4tJP57R_Ju
zhB$H<Mx~{NSx?cG77K|`e7HQAXR+|ddI>wf=TB`I-Kk9b7yI(-dY2$&SJyi3+S4|u
zz%{hEvc4(F+D~~Gtx=H&8DI88#0*Z>wKq<(@Nb)8AKtb(J56j+(KlY@?si90Qtilp
z*GxAFYNhHsbNDrL(w!_r%!gwoeZ&)O23^dT?q6mONpklC_iq&we_yIxKJGz1iS=&;
z-!1+8u|U{1FoJ9o#G08|cK_*IY??{UTQzaSPb(~<^R=U+X1;&p7T=?{?%x=Yz~O|f
zvaOmYyBElJzv4kdndB;i6(PpYU8@m{5=A{bbICs8j54`=WZUMBywS*otf3KFonqO8
zFI$2tP8ml{b*gt}_T2FH5z5t(MHt7W)83d^2DIY#ho(1Uw3@dr;N{;?_Q08~%_BUO
zaYPq9l^^xniz1fHP!irE0-D#sI9;-IwjGu$Z#aM7@TAb?zOZRN%jlD@esz1W8BTMP
zk(){1p0#d>{(66Uzt<gjUt(pCz8PWUUDM}o3?KU({Lo`edu9n|kSaC(Fkv>~4R7#d
zGE2Q>aJ^jH;%w>EQO~UQGH|zS&qo(=dm|-!EzgAl2^I`jrv$;m9k7(WK+Eu%(Wt!$
z({Q>_o2D}ROi0AWz^AStyf%5oX%;sMTyL@p9?k5SfG|(Bz`yUh#?+Ib75YS>zb72O
z+aH|MO|JYC%rgWn)B89WV2Cyep*wYC)Wh#}sm5!H8$(;>`P{9(zChO9vSw57Z+NTe
z=lP|A(<>*{)mVMhAk8S15UX|KhJtPNw=CSRSmTR19*<!s&vEc$Ka0;D<zHgNeuxxX
z3>}?|R+eC>GF7XgU+V&Ebel~R#`f{0MNAS?hMi_f0dG#t$w;YX>x5vrzeIlwn3JVm
z1DOeX9uQQ=HdoUnEh9l$zs@O{&+)*yQd`|!R0b@gl<7tOEEYQR66ZcE>#}<2alut*
znb{?sRRp5_d)j2x@jO@F4@6Z59Npv>M$L&yWu~z3^-_@ae7yk8PC&9RGA*j@Cm-UG
zurCswux=}Df5n-;XbON!fWC~gi8yP*0)?kAW$RBJF0ovx(PN}3z<_r0@U}fnljJB?
z15%ga#D3bDU*52c^KkKZBaKmVx;;6KG>e18t~aTLkCwDISDl<`;d{HfvZ?PaE*pWH
zUH!DZTuRCz5{0+M04>$`D0>Z0|IY=8%!yby!Ey629Ic<{llSZ<a8s@*<v1;jRuAee
zAcndiM#}YuB-zg?Y&Ca=EA*aFJ@+t2)QZK9C;L@=r^Tt5jniAh0-`823?T$_wvTA6
zNpfbT<(cdI_`XF3*g$gKx)bcrS}wI8C)x4c5b^RlMca{eR7sS+I~hZDTKwkb{=8;U
z-sQ`?@dmbUfqquB^HyRVs;RZ-g=hoaXW8M1mB40>Grm}!OX`S<(aOz>PWCYy?b4;4
zs<dkGmBb2SBC`7O$r{9khp<k(dbvE_oYr#HrDk}Q*yPpWYx$1gmoicsvk@`#<Bq=4
zaZxg(1^R9aTzgpS=0MPNb*ORy05<(xS)O{$-D}3+8@m2@Pm!Tw)Z-%U_4Y-_nFlb-
z_y!;T*_jennR@BAr3L_#%RV#x(En0Od^nR%YZ}B_ls@32e_nOL2nC!4J`s7L;z1aD
z3@W0&&Xn~I=r#flQG-AW0#It<sc{v6J00$!@{Cv|B`*5?spx}Jn#jCIgv=0bBA%;F
zmL5aFs9qPY?_(c$-=0JXBtXXw#xKNz!oeAh>=IBg#k`JcxXvnKR`lqRO?QYMm%|It
zLnU7xnpxWuE0|i8y;zB1P2A5VsmE8uQ7ExLY~M+$%2+&(8JI73>QuEZT0eK6Tktv8
zHWILH$3jI2mFwM0=H_2<n;Z>SbN}F(=O~D5S|h$8SpD3Ix{2IiJmR`h?}!`{i)Opb
zYB7~|hDvtLTJ2z@n#V!TI3%(?u1MzRI<^^=f&8h4W8nMFxJLU8lmk0umS^Tc3<VOA
zEgdU+NHi73oL!1dL5$!N`mn1IhV7pZS!7<f7!C!L!81Ybjv6SpQ(UgBx&Pe9!(rS5
zPmOC?abhy@PXl%2B+u`@c%ar@e^0<;w=+D6<@}Xnl>*#p=LSwQDDd7ZyNqR%mgigw
z&Xokng)8!&EU${mI|~ZzdFKYMf4yy@MT$W;8+w^r5|G24cV#ph9MnltUk}g5>~d7U
zcC)_uM5a5$vq&p*BC{YA(P(5_7vcx^|8-`)OQ%t+@!S;+Pg#|>1#jxF-GeSxd*2Xz
z@lvE;gm6)iKBkWtS@v>EDsgg6XNwOxglVJ}6H-*03`NIP#J-0hdqSm9&<amp(a*WR
z1uHxSe<~AGT!inLU313Va(~j@+p9L<tTA1-(p@?((_mQH_imG{S?Yw7^nztWN<Op4
zra)FGYd_9?oNqg0_64ISc9>m&2tt0IY*Xp%vyP)&yf7e`E!EupEqCrjt!$~uNTbFF
zIL@q*SQUW@YaJ&7bJEf|7Xsfw&(3SnpQe<qj6D9DS&1|%TYDd9ef!QutglfVDXjc{
zOALo%%T|o=UqjrZB}5y<w{Nbx&W2L&)MiDm=(p1Fz$(y@b=dz9H&!F)p%#E!yDwJs
znTng~_Fzs}Kf*`*d;R#QwjCJ0R#|QFKEV3-{4~<BcF>`b+*x(xmg%nNYgc0nRx9X#
zUIB8o_%{jnPs0D7#NdBR*#9HE|4UmN`>(@pReLGaf;Ig2>~j2=Kc~YrBrm_NZM==i
zdrd+qft|ae9ZR;;XQZ?7q1VlemSeS*ObxhCewa7_PZzc|N&d0_-c~(D({7-wwmgHs
z1nk?(<wq@4N{+DLqx_A9L6L==yris4@M4L9hspT?6?Z_r>If~?VwZ5y4xY35(Ua91
z@HK@{-s@d#J%E&WpkOqUhv6+iP6^dAd!&&dQj_>W-A@Rl({Tx=P8|;Bj6!h_3_C8&
z;)p69f<`J3nIzA+AsR~(A@j%V640)&fqUT`l+-V>ot0=zovUUNd;U!_3W|?juy613
zsIAn5h0P0V*kqxaTwi|g>v=rVVKC^Vq3ORv+$jQhp$wyR4uRDOyS^{HxR1>u6qjI=
zhTHZ+Jr`cxP!;OrHsl>BDbiNOuz>+*LFHz%@(Z`^Cmj`~L5ev$D}3FzUIAD%TLES=
zikvo;?233%8_2x6>#GBQmh;bYr6xB_;`?)4ITEDp4@GCAQ`h+H;~(<!aShI9Tk-uZ
z)x8@h)#wRXgK^VR<Aix=me1J({*d<M1Q|Z@8h)eBuED`9iU;P(=#v#%-~$D{rTVP<
zFJJ4enrXTu=YfhskV{jJirb|ek|bk$72y2MIZ?1kzt@bfsQ6}XbfK(iC+(70690lD
z4q<x2_a!@zbkpzGJW&B&Z-kg5c$gPvn+#cH^59=sFCTD&ZC{pjmB#e6HG9IYUbQL|
zD=zsJIwXVc34w9Oiwp=<_P_rmQ1*T7NBNFdj3>4$F><DFRBQU<hDDE<JYRL~>kxhg
zIcD_Zpz3skK3&I5<M@c2cV5$OL-e%tPaEDh)((6SyuQz4`=-bRgRGPwJiKM=$G89g
kVG;WzaA@W3#@}f3o|J>dfe$NoH@g4kn*R+r^d7nY0O#g{w*UYD

literal 0
HcmV?d00001

diff --git a/docs/the-book/carts-and-orders/shipments.md b/docs/the-book/carts-and-orders/shipments.md
index 626579efcf..5f7508e1c8 100644
--- a/docs/the-book/carts-and-orders/shipments.md
+++ b/docs/the-book/carts-and-orders/shipments.md
@@ -1,6 +1,118 @@
 ---
-hidden: true
+layout:
+  title:
+    visible: true
+  description:
+    visible: false
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: true
 ---
 
 # Shipments
 
+A shipment represents a shipping request for an order in Sylius. Each order can have multiple shipments, and each shipment is made up of `ShipmentUnits`, which correspond to `OrderItemUnits` from the order.
+
+## Creating a Shipment for an Order
+
+{% hint style="info" %}
+To understand the process of creating shipments, refer to the guide on [Orders](orders.md) where shipments are covered in detail.
+{% endhint %}
+
+### Splitting Shipments
+
+In Sylius Plus, orders can be fulfilled partially, allowing for shipment splitting. This feature provides a UI where you can select items from an existing shipment to create a new one and send it (with or without a tracking code). Shipments can be split as long as at least one shipment remains in the `ready` state.
+
+### Shipment State Machine
+
+Each shipment has its own state machine with these states: `cart`, `ready`, `cancelled`, `shipped`.
+
+**Available Transitions:**
+
+```
+transitions:
+     create:
+         from: [cart]
+         to: ready
+     ship:
+         from: [ready]
+         to: shipped
+     cancel:
+         from: [ready]
+         to: cancelled
+```
+
+<figure><img src="../../.gitbook/assets/sylius_shipment.webp" alt=""><figcaption></figcaption></figure>
+
+## Shipping Methods
+
+A `ShippingMethod` in Sylius represents how an order is shipped to a customer.
+
+**Creating a ShippingMethod Programmatically:**
+
+```php
+$shippingMethod = $this->container->get('sylius.factory.shipping_method')->createNew();
+$shippingMethod->setCode('DHL');
+$shippingMethod->setCalculator(DefaultCalculators::FLAT_RATE);
+$shippingMethod->setConfiguration(['channel_code' => ['amount' => 50]]);
+
+$zone = $this->container->get('sylius.repository.zone')->findOneByCode('US');
+$shippingMethod->setZone($zone);
+
+$this->container->get('sylius.repository.shipping_method')->add($shippingMethod);
+```
+
+To make a shipping method available during checkout, add it to a channel:
+
+```php
+$channel = $this->container->get('sylius.repository.channel')->findOneByCode('channel_code');
+$channel->addShippingMethod($shippingMethod);
+```
+
+### Shipping Method Rules
+
+Rules define when a shipping method is available. Each rule type has a `RuleChecker` that checks conditions like:
+
+* All products in a certain taxon
+* Order total greater than a specific amount
+* Total weight below a certain number
+* Total volume below a certain value
+
+**Rule Types:**
+
+* **Items total greater than or equal**
+* **Items total less than or equal**
+* **Total weight greater than or equal**
+* **Total weight less than or equal**
+
+## Shipping Zones
+
+Shipping zones specify where shipping methods apply. For example, you can configure methods for specific countries. Ensure that each `ShippingMethod` is assigned to the correct zone, as the available methods are based on the customer’s address.
+
+## Shipping Cost Calculators
+
+Shipping cost calculators determine the cost of a shipment. The `CalculatorInterface` has a `calculate()` method that takes a configuration object and returns the shipping cost. The `DelegatingCalculator` selects the appropriate calculator type based on the `ShippingMethod`.
+
+Example:
+
+```php
+$shippingCalculator = $this->container->get('sylius.shipping_calculator');
+$cost = $shippingCalculator->calculate($shipment);
+```
+
+### Built-in Calculators
+
+Sylius includes these built-in calculators:
+
+* **FlatRateCalculator**: Returns a fixed amount from the `ShippingMethod` configuration.
+* **PerUnitRateCalculator**: Multiplies the configuration amount by the number of units.
+
+## Shipment Complete Events
+
+These events are triggered when a shipment is marked as shipped:
+
+* `sylius.shipment.pre_ship`
+* `sylius.shipment.post_ship`