Merge pull request #271 from MyParcelCOM/develop

MyParcelCOM · Nov 27, 2024 · 69fbb78 · 69fbb78
2 parents 7b7044d + 04018af
commit 69fbb78
Show file tree

Hide file tree

Showing 5 changed files with 166 additions and 13 deletions.
diff --git a/specification/paths.json b/specification/paths.json
@@ -1,4 +1,7 @@
 {
+  "/validate-credentials": {
+    "$ref": "./paths/ValidateCredentials.json"
+  },
   "/collection-time-slots": {
     "$ref": "./paths/CollectionTimeSlots.json"
   },
@@ -11,12 +14,12 @@
   "/get-service-rates": {
     "$ref": "./paths/ServiceRates.json"
   },
+  "/get-multi-colli-service-rates": {
+    "$ref": "./paths/MultiColliServiceRates.json"
+  },
   "/manifests": {
     "$ref": "./paths/Manifests.json"
   },
-  "/multi-colli-shipments": {
-    "$ref": "./paths/MultiColliShipments.json"
-  },
   "/pickup-dropoff-locations/{pudo_id}": {
     "$ref": "./paths/PickupDropoffLocations-pudo_id.json"
   },
@@ -29,6 +32,9 @@
   "/shipments": {
     "$ref": "./paths/Shipments.json"
   },
+  "/multi-colli-shipments": {
+    "$ref": "./paths/MultiColliShipments.json"
+  },
   "/shipments/{shipment_id}": {
     "$ref": "./paths/Shipments-shipment_id.json"
   },
@@ -37,8 +43,5 @@
   },
   "/shipments/{shipment_id}/statuses/{tracking_code}": {
     "$ref": "./paths/Shipments-shipment_id-Statuses-tracking_code.json"
-  },
-  "/validate-credentials": {
-    "$ref": "./paths/ValidateCredentials.json"
   }
 }
diff --git a/specification/paths/MultiColliServiceRates.json b/specification/paths/MultiColliServiceRates.json
@@ -0,0 +1,149 @@
+{
+  "post": {
+    "tags": [
+      "ServiceRates"
+    ],
+    "summary": "Get service rates for a multi-colli shipment",
+    "description": "This endpoint retrieves service rates from the carrier based on the supplied multi-colli shipment.",
+    "requestBody": {
+      "description": "The virtual master shipment and colli shipments to be created as one multi-colli shipment.",
+      "required": true,
+      "content": {
+        "application/vnd.api+json": {
+          "schema": {
+            "type": "object",
+            "required": [
+              "data"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "data": {
+                "type": "object",
+                "required": [
+                  "master",
+                  "colli"
+                ],
+                "properties": {
+                  "master": {
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/Shipment"
+                      },
+                      {
+                        "required": [
+                          "attributes"
+                        ],
+                        "properties": {
+                          "id": {
+                            "readOnly": true
+                          },
+                          "attributes": {
+                            "required": [
+                              "recipient_address",
+                              "sender_address",
+                              "service",
+                              "physical_properties"
+                            ],
+                            "properties": {
+                              "recipient_address": {
+                                "required": [
+                                  "street_1",
+                                  "city",
+                                  "country_code"
+                                ]
+                              },
+                              "sender_address": {
+                                "required": [
+                                  "street_1",
+                                  "city",
+                                  "country_code"
+                                ]
+                              },
+                              "service": {
+                                "required": [
+                                  "code"
+                                ]
+                              },
+                              "physical_properties": {
+                                "required": [
+                                  "weight"
+                                ]
+                              }
+                            }
+                          }
+                        }
+                      }
+                    ]
+                  },
+                  "colli": {
+                    "type": "array",
+                    "items": {
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/Shipment"
+                        },
+                        {
+                          "required": [
+                            "attributes"
+                          ],
+                          "properties": {
+                            "id": {
+                              "readOnly": true
+                            },
+                            "attributes": {
+                              "required": [
+                                "physical_properties"
+                              ],
+                              "properties": {
+                                "physical_properties": {
+                                  "required": [
+                                    "weight"
+                                  ]
+                                },
+                                "items": {
+                                  "items": {
+                                    "required": [
+                                      "description",
+                                      "quantity"
+                                    ]
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Retrieved the service rates.",
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "data"
+              ],
+              "properties": {
+                "data": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ServiceRateResponse"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/specification/paths/MultiColliShipments.json b/specification/paths/MultiColliShipments.json
@@ -1,7 +1,7 @@
 {
   "post": {
     "tags": [
-      "MultiColliShipments"
+      "Shipments"
     ],
     "summary": "Create a multi-colli shipment.",
     "description": "This endpoint creates a new multi-colli shipment in the system of the carrier.",
@@ -19,6 +19,10 @@
             "properties": {
               "data": {
                 "type": "object",
+                "required": [
+                  "master",
+                  "colli"
+                ],
                 "properties": {
                   "master": {
                     "allOf": [

diff --git a/specification/paths/ValidateCredentials.json b/specification/paths/ValidateCredentials.json
@@ -1,7 +1,7 @@
 {
   "get": {
     "tags": [
-      "ValidateCredentials"
+      "Credentials"
     ],
     "summary": "Validate credentials.",
     "description": "This endpoint validates the credentials in the headers with the system of the carrier.",

diff --git a/specification/tags.json b/specification/tags.json
@@ -3,10 +3,10 @@
     "name": "Collections"
   },
   {
-    "name": "Manifests"
+    "name": "Credentials"
   },
   {
-    "name": "MultiColliShipments"
+    "name": "Manifests"
   },
   {
     "name": "PickupDropoffLocations"
@@ -16,8 +16,5 @@
   },
   {
     "name": "Shipments"
-  },
-  {
-    "name": "ValidateCredentials"
   }
 ]