Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
68539be
IBX-5749: [REST] Implemented endpoints to get shipping method types
MagdalenaZuba Jul 7, 2023
5dc354c
IBX-5751: [REST] Implemented endpoints to retrieve Shipments of an Orde
MagdalenaZuba Jul 11, 2023
e0c45bc
IBX-5750: [REST] Implemented endpoints to get shipping methods
MagdalenaZuba Jul 12, 2023
0182a08
Merge branch 'master' into shipment_rest_api
MagdalenaZuba Oct 10, 2023
54eb1a4
Update shipping method and shipping method types
adriendupuis Oct 12, 2023
9483170
Update shipment, shipping method and shipping method types
adriendupuis Oct 12, 2023
2dbb500
Fill-in ShipmentRefList.*.example
adriendupuis Oct 12, 2023
75a814c
Fill-in ShipmentUpdate.*.example and resulting Shipment.*.example
adriendupuis Oct 12, 2023
786d213
ez-types.raml: Update Shipment
adriendupuis Oct 12, 2023
24d1698
ez-types.raml: Update Shipment
adriendupuis Oct 12, 2023
9456d4a
ShipmentUpdate: new Shipment status after transition
adriendupuis Oct 12, 2023
b2a704a
Rebuild rest_api_reference.html
adriendupuis Oct 12, 2023
9d16685
Fix REST ShippingMethod
adriendupuis Dec 8, 2023
40355ca
re-build rest_api_reference.html
adriendupuis Dec 11, 2023
35944f2
Merge branch 'master' into shipment_rest_api
adriendupuis Jan 19, 2024
15d889d
Ship*.*.example: Add missing EOF new lines
adriendupuis Jan 19, 2024
7bc6eae
ez-shipments.raml: Fix identifier param, add displayName and EOF NL
adriendupuis Jan 19, 2024
63a3945
Shipment.*.example: parcel_locker_delivery
adriendupuis Jan 19, 2024
5a05e64
ShippingMethodRefList.xml.example: Add contents
adriendupuis Jan 19, 2024
5e24f8f
Shipment.*.example: parcel_locker_delivery
adriendupuis Jan 19, 2024
cd592bc
ez-shipping.raml: Add XML to /shipping/method-types/{identifier}
adriendupuis Jan 19, 2024
9be9710
ez-types.raml: Describe ShippingMethod & ShipmentUpdate
adriendupuis Jan 19, 2024
481b043
ez-types.raml: Fix indent
adriendupuis Jan 19, 2024
77593b0
ez-types.raml: Update URL examples
adriendupuis Jan 19, 2024
e9557ee
ez-types.raml: Fix typos
adriendupuis Jan 19, 2024
2f9cb3d
rest_api_reference.html: Rebuild after input changes
adriendupuis Jan 19, 2024
55a0a86
Apply suggestions from code review
adriendupuis Feb 8, 2024
94ec81c
rest_api_reference.html rebuild
adriendupuis Feb 8, 2024
6bd323e
Merge branch 'master' into shipment_rest_api
adriendupuis Feb 8, 2024
f25335c
rest_api_reference.html rebuild after merge
adriendupuis Feb 8, 2024
4d1dff8
Merge branch 'master' into shipment_rest_api
adriendupuis Feb 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"ShipmentRefList": {
"_media-type": "application\/vnd.ibexa.api.ShipmentRefList+json",
"_href": "\/api\/ibexa\/v2\/shipments",
"shipmentRefList": [
{
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/foo"
},
{
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/bar"
},
{
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/baz"
},
{
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/qux"
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<ShipmentRefList media-type="application/vnd.ibexa.api.ShipmentRefList+xml" href="/api/ibexa/v2/shipments">
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/foo"/>
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/bar"/>
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/baz"/>
<ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/qux"/>
</ShipmentRefList>
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"Shipment": {
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/ae741491-e80c-49f2-8a44-5163b4afa144",
"id": 1,
"identifier": "ae741491-e80c-49f2-8a44-5163b4afa144",
"status": "pending",
"transitions": {
"transitionList": [
"prepare",
"cancel"
]
},
"Order": {
"_media-type": "application\/vnd.ibexa.api.Order+json",
"_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
},
"Amount": {
"value": "2257",
"currency": "EUR"
},
"createdAt": "2023-06-26T15:40:28+02:00",
"updatedAt": "2023-06-26T15:40:28+02:00",
"Owner": {
"_media-type": "application\/vnd.ibexa.api.User+json",
"_href": "\/api\/ibexa\/v2\/user\/users\/14"
},
"Method": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/ae741491-e80c-49f2-8a44-5163b4afa144">
<id>1</id>
<identifier>ae741491-e80c-49f2-8a44-5163b4afa144</identifier>
<status>pending</status>
<transitions>
<transition>prepare</transition>
<transition>cancel</transition>
</transitions>
<Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
<Amount>
<value>2257</value>
<currency>EUR</currency>
</Amount>
<createdAt>2023-06-26T15:40:28+02:00</createdAt>
<updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
<Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</Shipment>
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"Shipment": {
"_media-type": "application\/vnd.ibexa.api.Shipment+json",
"_href": "\/api\/ibexa\/v2\/shipments\/new_identifier",
"id": 1,
"identifier": "new_identifier",
"status": "prepared",
"transitions": {
"transitionList": [
"send-to-carrier",
"cancel"
]
},
"Order": {
"_media-type": "application\/vnd.ibexa.api.Order+json",
"_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
},
"Amount": {
"value": "2257",
"currency": "EUR"
},
"createdAt": "2023-06-26T15:40:28+02:00",
"updatedAt": "2023-06-26T15:40:28+02:00",
"Owner": {
"_media-type": "application\/vnd.ibexa.api.User+json",
"_href": "\/api\/ibexa\/v2\/user\/users\/14"
},
"Method": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/new_identifier">
<id>1</id>
<identifier>new_identifier</identifier>
<status>prepared</status>
<transitions>
<transition>send-to-carrier</transition>
<transition>cancel</transition>
</transitions>
<Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
<Amount>
<value>2257</value>
<currency>EUR</currency>
</Amount>
<createdAt>2023-06-26T15:40:28+02:00</createdAt>
<updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
<Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</Shipment>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"ShipmentUpdate": {
"identifier": "new_identifier",
"transition": "prepare",
"Owner": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
},
"Context": {
"item1": "value1",
"item2": "value2"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<ShipmentUpdate>
<identifier>new_identifier</identifier>
<transition>prepare</transition>
<Owner media-type='application/vnd.ibexa.api.User+json' href='/api/ibexa/v2/user/users/14'/>
<Context>
<item1>value1</item1>
<item2>value2</item2>
</Context>
</ShipmentUpdate>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"ShippingMethodTypesList": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethodTypesList+json",
"_href": "\/api\/ibexa\/v2\/shipping\/method-types",
"ShippingMethodTypes": [
{
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate",
"identifier": "flat_rate",
"name": "Flat rate"
},
{
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/free",
"identifier": "free",
"name": "Free shipping"
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodTypesList media-type="application/vnd.ibexa.api.ShippingMethodTypesList+xml" href="/api/ibexa/v2/shipping/method-types">
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate">
<identifier>flat_rate</identifier>
<name>Flat rate</name>
</ShippingMethodType>
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/free">
<identifier>free</identifier>
<name>Free shipping</name>
</ShippingMethodType>
</ShippingMethodTypesList>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"ShippingMethodType": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate",
"identifier": "flat_rate",
"name": "Flat rate"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate">
<identifier>flat_rate</identifier>
<name>Flat rate</name>
</ShippingMethodType>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"ShippingMethodRefList": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethodRefList+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods",
"ShippingMethodRefs": [
{
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_delivery"
},
{
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodRefList media-type="application/vnd.ibexa.api.ShippingMethodRefList+xml" href="/api/ibexa/v2/shipping/methods">
<ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_delivery"/>
<ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</ShippingMethodRefList>
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"ShippingMethod": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
"_href": "\/api\/ibexa\/v2\/shipping\/methods\/method1",
"identifier": "method1",
"name": "AmE Method 1",
"names": {
"value": [
{
"_languageCode": "eng-US",
"#text": "AmE Method 1"
},
{
"_languageCode": "eng-GB",
"#text": "BrE Method 1"
}
]
},
"description": "AmE Description of Method 1",
"descriptions": {
"value": [
{
"_languageCode": "eng-US",
"#text": "AmE Description of Method 1"
},
{
"_languageCode": "eng-GB",
"#text": "BrE Description of Method 1"
}
]
},
"enabled": true,
"options": {
"option": [
{
"_key": "price",
"#text": "20.0000"
},
{
"_key": "currency",
"#text": "EUR"
}
]
},
"regions": {
"RegionRefList": [
{
"_media-type": "application\/vnd.ibexa.api.Region+json",
"_href": "\/api\/ibexa\/v2\/product\/catalog\/regions\/default"
}
]
},
"type": {
"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<ShippingMethod media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/method1">
<identifier>method1</identifier>
<name>AmE Method 1</name>
<names>
<value languageCode="eng-US">AmE Method 1</value>
<value languageCode="eng-GB">BrE Method 1</value>
</names>
<description>AmE Description of Method 1</description>
<descriptions>
<value languageCode="eng-US">AmE Description of Method 1</value>
<value languageCode="eng-GB">BrE Description of Method 1</value>
</descriptions>
<enabled>true</enabled>
<options>
<value key="price">20.0000</value>
<value key="currency">EUR</value>
</options>
<regions>
<RegionRef media-type="application/vnd.ibexa.api.Region+xml" href="/api/ibexa/v2/product/catalog/regions/default"/>
</regions>
<type media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate"/>
</ShippingMethod>
29 changes: 29 additions & 0 deletions docs/api/rest_api/rest_api_reference/input/ez-orders.raml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,35 @@ displayName: Orders
description: Error - the user has no permission to read orders.
404:
description: Error - the order does not exist.

/shipments:
get:
displayName: Load shipments
description: Loads a list of shipments.
headers:
Accept:
description: If set, the shipments are returned in XML or JSON format.
example: |
application/vnd.ibexa.api.ShipmentRefList+xml
Content-Type:
description: The shipments schema encoded in XML or JSON format.
example: |
application/vnd.ibexa.api.ShipmentRefList+xml
responses:
200:
description: OK - loads the shipments.
body:
application/vnd.ibexa.api.Shipment+xml:
type: Shipment
example: !include examples/shipments/GET/ShipmentRefList.xml.example
application/vnd.ibexa.api.Shipment+json:
type: Shipment
example: !include examples/shipments/GET/ShipmentRefList.json.example
401:
description: Error - the user has no permission to read shipment lists.
404:
description: Error - the shipment does not exist.

/{id}:
get:
displayName: Load order by ID
Expand Down
Loading