Merge pull request #1278 from MyParcelCOM/develop

Author: zwaans

specification/info.json

@@ -1,15 +1,15 @@
 {
   "title": "MyParcel.com API Specification",
   "description": "**Introduction**<br>This is the technical reference for the MyParcel.com API implementing the [OpenApi 3.0 Specification](https://github.com/OAI/OpenAPI-Specification) according to [JSON API](https://jsonapi.org) conventions.<br>Check our [API documentation](https://docs.myparcel.com) for more information and code examples.<br>Check our [GitHub releases](https://github.com/MyParcelCOM/api-specification/releases) for a complete version history.<br><br>⚠ Some endpoints are marked as experimental, which means their implementation might change within this major version.<br><br>**Units**<br>Some attributes in the API have values in one of the following units: <table><tr><th>Currency</th><td>cents / pence</td></tr><tr><th>Distances</th><td>meters</td></tr><tr><th>Dimensions</th><td>millimeters</td></tr><tr><th>Timestamps</th><td>Coordinated Universal Time (UTC)</td></tr><tr><th>Volumes</th><td>liters (dm3)</td></tr><tr><th>Weights</th><td>grams</td></tr></table>",
-  "termsOfService": "https://www.myparcel.com/legal",
+  "termsOfService": "https://solutions.myparcel.com/legal",
   "contact": {
     "name": "Tech Support",
-    "url": "https://www.myparcel.com/contact",
+    "url": "https://solutions.myparcel.com/contact",
     "email": "support@myparcel.com"
   },
   "license": {
     "name": "pricing",
-    "url": "https://www.myparcel.com/pricing"
+    "url": "https://solutions.myparcel.com/pricing"
   },
   "version": "$RELEASE_VERSION",
   "x-logo": {

specification/paths/RegisteredShipments.json

@@ -80,6 +80,12 @@
                               "address"
                             ]
                           },
+                          "drop_off_location": {
+                            "required": [
+                              "code",
+                              "address"
+                            ]
+                          },
                           "tracking_code": {
                             "readOnly": true
                           },

specification/paths/Shipments.json

@@ -237,6 +237,12 @@
                               "address"
                             ]
                           },
+                          "drop_off_location": {
+                            "required": [
+                              "code",
+                              "address"
+                            ]
+                          },
                           "tracking_code": {
                             "readOnly": true
                           },

specification/schemas.json

@@ -170,6 +170,12 @@
   "DocumentType": {
     "$ref": "./schemas/files/DocumentType.json"
   },
+  "PickupLocation": {
+    "$ref": "./schemas/shipments/PickupLocation.json"
+  },
+  "DropOffLocation": {
+    "$ref": "./schemas/shipments/DropOffLocation.json"
+  },
   "DemoOrder": {
     "$ref": "./schemas/return-orders/DemoOrder.json"
   },

specification/schemas/shipments/DropOffLocation.json

@@ -0,0 +1,15 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "code": {
+      "type": "string",
+      "example": "205604",
+      "description": "Code of the drop-off location, retrieved from the `pickup-dropoff-locations` endpoint."
+    },
+    "address": {
+      "$ref": "#/components/schemas/BaseAddress"
+    }
+  },
+  "description": "Required if the service handover method is `drop-off`."
+}

specification/schemas/shipments/PickupLocation.json

@@ -0,0 +1,14 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "code": {
+      "type": "string",
+      "example": "205604"
+    },
+    "address": {
+      "$ref": "#/components/schemas/BaseAddress"
+    }
+  },
+  "description": "Required if the service delivery method is `pick-up`."
+}

specification/schemas/shipments/Shipment.json

@@ -52,18 +52,17 @@
             "pickup_location": {
               "oneOf": [
                 {
-                  "type": "object",
-                  "additionalProperties": false,
-                  "properties": {
-                    "code": {
-                      "type": "string",
-                      "example": "205604"
-                    },
-                    "address": {
-                      "$ref": "#/components/schemas/BaseAddress"
-                    }
-                  },
-                  "description": "Required if the service delivery method is `pick-up`."
+                  "$ref": "#/components/schemas/PickupLocation"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "drop_off_location": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/DropOffLocation"
                 },
                 {
                   "type": "null"

specification/schemas/shipments/ShipmentResponse.json

@@ -51,6 +51,12 @@
                 "address"
               ]
             },
+            "drop_off_location": {
+              "required": [
+                "code",
+                "address"
+              ]
+            },
             "physical_properties": {
               "required": [
                 "weight"