Skip to content

Commit 3309727

Browse files
MagdalenaZubaMagdalenaZuba
authored
IBX-5710: Shipping REST API (#2053)
1 parent 42ec3ec commit 3309727

22 files changed

+5846
-949
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/GET/ShipmentRefList.json.example‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"ShipmentRefList": {
3+
"_media-type": "application\/vnd.ibexa.api.ShipmentRefList+json",
4+
"_href": "\/api\/ibexa\/v2\/shipments",
5+
"shipmentRefList": [
6+
{
7+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
8+
"_href": "\/api\/ibexa\/v2\/shipments\/foo"
9+
},
10+
{
11+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
12+
"_href": "\/api\/ibexa\/v2\/shipments\/bar"
13+
},
14+
{
15+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
16+
"_href": "\/api\/ibexa\/v2\/shipments\/baz"
17+
},
18+
{
19+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
20+
"_href": "\/api\/ibexa\/v2\/shipments\/qux"
21+
}
22+
]
23+
}
24+
}

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/GET/ShipmentRefList.xml.example‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ShipmentRefList media-type="application/vnd.ibexa.api.ShipmentRefList+xml" href="/api/ibexa/v2/shipments">
3+
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/foo"/>
4+
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/bar"/>
5+
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/baz"/>
6+
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/qux"/>
7+
</ShipmentRefList>

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/GET/Shipment.json.example‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"Shipment": {
3+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
4+
"_href": "\/api\/ibexa\/v2\/shipments\/ae741491-e80c-49f2-8a44-5163b4afa144",
5+
"id": 1,
6+
"identifier": "ae741491-e80c-49f2-8a44-5163b4afa144",
7+
"status": "pending",
8+
"transitions": {
9+
"transitionList": [
10+
"prepare",
11+
"cancel"
12+
]
13+
},
14+
"Order": {
15+
"_media-type": "application\/vnd.ibexa.api.Order+json",
16+
"_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
17+
},
18+
"Amount": {
19+
"value": "2257",
20+
"currency": "EUR"
21+
},
22+
"createdAt": "2023-06-26T15:40:28+02:00",
23+
"updatedAt": "2023-06-26T15:40:28+02:00",
24+
"Owner": {
25+
"_media-type": "application\/vnd.ibexa.api.User+json",
26+
"_href": "\/api\/ibexa\/v2\/user\/users\/14"
27+
},
28+
"Method": {
29+
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
30+
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
31+
}
32+
}
33+
}

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/GET/Shipment.xml.example‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/ae741491-e80c-49f2-8a44-5163b4afa144">
3+
<id>1</id>
4+
<identifier>ae741491-e80c-49f2-8a44-5163b4afa144</identifier>
5+
<status>pending</status>
6+
<transitions>
7+
<transition>prepare</transition>
8+
<transition>cancel</transition>
9+
</transitions>
10+
<Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
11+
<Amount>
12+
<value>2257</value>
13+
<currency>EUR</currency>
14+
</Amount>
15+
<createdAt>2023-06-26T15:40:28+02:00</createdAt>
16+
<updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
17+
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
18+
<Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
19+
</Shipment>

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/PATCH/Shipment.json.example‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"Shipment": {
3+
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
4+
"_href": "\/api\/ibexa\/v2\/shipments\/new_identifier",
5+
"id": 1,
6+
"identifier": "new_identifier",
7+
"status": "prepared",
8+
"transitions": {
9+
"transitionList": [
10+
"send-to-carrier",
11+
"cancel"
12+
]
13+
},
14+
"Order": {
15+
"_media-type": "application\/vnd.ibexa.api.Order+json",
16+
"_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
17+
},
18+
"Amount": {
19+
"value": "2257",
20+
"currency": "EUR"
21+
},
22+
"createdAt": "2023-06-26T15:40:28+02:00",
23+
"updatedAt": "2023-06-26T15:40:28+02:00",
24+
"Owner": {
25+
"_media-type": "application\/vnd.ibexa.api.User+json",
26+
"_href": "\/api\/ibexa\/v2\/user\/users\/14"
27+
},
28+
"Method": {
29+
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
30+
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
31+
}
32+
}
33+
}

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/PATCH/Shipment.xml.example‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/new_identifier">
3+
<id>1</id>
4+
<identifier>new_identifier</identifier>
5+
<status>prepared</status>
6+
<transitions>
7+
<transition>send-to-carrier</transition>
8+
<transition>cancel</transition>
9+
</transitions>
10+
<Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
11+
<Amount>
12+
<value>2257</value>
13+
<currency>EUR</currency>
14+
</Amount>
15+
<createdAt>2023-06-26T15:40:28+02:00</createdAt>
16+
<updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
17+
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
18+
<Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
19+
</Shipment>

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/PATCH/ShipmentUpdate.json.example‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"ShipmentUpdate": {
3+
"identifier": "new_identifier",
4+
"transition": "prepare",
5+
"Owner": {
6+
"_media-type": "application/vnd.ibexa.api.User+json",
7+
"_href": "/api/ibexa/v2/user/users/14"
8+
},
9+
"Context": {
10+
"item1": "value1",
11+
"item2": "value2"
12+
}
13+
}
14+
}

‎docs/api/rest_api/rest_api_reference/input/examples/shipments/identifier/PATCH/ShipmentUpdate.xml.example‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<ShipmentUpdate>
3+
<identifier>new_identifier</identifier>
4+
<transition>prepare</transition>
5+
<Owner media-type='application/vnd.ibexa.api.User+json' href='/api/ibexa/v2/user/users/14'/>
6+
<Context>
7+
<item1>value1</item1>
8+
<item2>value2</item2>
9+
</Context>
10+
</ShipmentUpdate>

‎docs/api/rest_api/rest_api_reference/input/examples/shipping/method-types/GET/ShippingMethodTypesList.json.example‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"ShippingMethodTypesList": {
3+
"_media-type": "application\/vnd.ibexa.api.ShippingMethodTypesList+json",
4+
"_href": "\/api\/ibexa\/v2\/shipping\/method-types",
5+
"ShippingMethodTypes": [
6+
{
7+
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
8+
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate",
9+
"identifier": "flat_rate",
10+
"name": "Flat rate"
11+
},
12+
{
13+
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
14+
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/free",
15+
"identifier": "free",
16+
"name": "Free shipping"
17+
}
18+
]
19+
}
20+
}

‎docs/api/rest_api/rest_api_reference/input/examples/shipping/method-types/GET/ShippingMethodTypesList.xml.example‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ShippingMethodTypesList media-type="application/vnd.ibexa.api.ShippingMethodTypesList+xml" href="/api/ibexa/v2/shipping/method-types">
3+
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate">
4+
<identifier>flat_rate</identifier>
5+
<name>Flat rate</name>
6+
</ShippingMethodType>
7+
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/free">
8+
<identifier>free</identifier>
9+
<name>Free shipping</name>
10+
</ShippingMethodType>
11+
</ShippingMethodTypesList>

0 commit comments

Comments
 (0)