PHPackages myparcelcom/api-specification - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. myparcelcom/api-specification ActiveLibrary[API Development](/categories/api) myparcelcom/api-specification ============================= MyParcel.com API specification based on the OpenAPI Specification. v1.80.8(1w ago)416.7k↓38.1%2[1 PRs](https://github.com/MyParcelCOM/api-specification/pulls)JavaScriptCI passing Since Sep 21Pushed 1w ago3 watchersCompare [ Source](https://github.com/MyParcelCOM/api-specification)[ Packagist](https://packagist.org/packages/myparcelcom/api-specification)[ Docs](https://api-specification.myparcel.com)[ RSS](/packages/myparcelcom-api-specification/feed)WikiDiscussions develop Synced 2d ago READMEChangelog (10)DependenciesVersions (340)Used By (0) MyParcel.com API specification ============================== [](#myparcelcom-api-specification) [![Packagist](https://camo.githubusercontent.com/2e7bf34f80af9fba718b0b368c2c33f694506a2f5598e0dc0e982541631e7faa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d7970617263656c636f6d2f6170692d73706563696669636174696f6e2e737667)](https://packagist.org/packages/myparcelcom/api-specification)[![OpenAPI Specification](https://camo.githubusercontent.com/8cf0a1734a5b3d953aef04153edcdc66c2de37f192ec28a8e6be511a5c448b88/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e4150492d332e312e302d627269676874677265656e2e737667)](https://github.com/OAI/OpenAPI-Specification) Description of the API specification used by MyParcel.com located at . This specification adheres to the [OpenApi 3.1 specification](https://github.com/OAI/OpenAPI-Specification) and implements the [JSON API specification](https://jsonapi.org). Content ------- [](#content) - [Installation](#installation) - [Commands](#commands) - [Conventions](#conventions) - [License](#license) Installation ------------ [](#installation) The repository provides Docker containers to validate and preview the spec before committing changes. This is also used when validating pull requests. To install Docker, follow the steps in the [documentation](https://docs.myparcel.com/development.html#docker). To set up the project for development run: ``` ./mp.sh setup ``` Commands -------- [](#commands) `./mp.sh up` - Start the containers which will start a server to watch file changes and reload automatically. `./mp.sh down` - Stop the containers. `./mp.sh validate` - Validate the specification. > **NOTE:** The validator only works when the containers are already running. Don't forget to start them. Conventions ----------- [](#conventions) Conventions based on the [Swagger](https://swagger.io/specification) and [JSON Schema](https://json-schema.org) specs. Our internal conventions are described below. ### PUT, POST, PATCH [](#put-post-patch) To avoid discussion, the use of the above HTTP methods is described below. #### `PUT` [](#put) - Used to create or replace a resource. - Always returns the same response on repeated requests. - Needs the full resource for the request (including the id for the to be created or replaced resource). #### `POST` [](#post) - Used to create a resource. - Does not return the same response on repeated requests. - Does not need the full resource for the request (often does not need the id for the to be created resource). #### `PATCH` [](#patch) - Used to update an existing resource. - Does not return the same response on repeated requests. - Does not need the full resource for the request (you might only want to update a user's name for example). ### API versioning [](#api-versioning) The API versioning follows semantic versioning. The increment in version number is done manually and should be part of the pull request. ### Schema file naming [](#schema-file-naming) Definition file names follow PascalCasing. Where every first letter of a word (including the first word) is uppercase. For example, the definition for a country code would be found in: ``` specification/schemas/CountryCode.json ``` ### Path file naming [](#path-file-naming) The files in `specification/paths` are named after their corresponding API endpoints. Where resources start with an uppercase letter and path variables with a lowercase letter. For example, the definition of the following route: ``` carriers/{carrier_id}/services ``` can be found in: ``` specification/paths/Carriers-carrier_id-Services.json ``` ### Parameter file naming [](#parameter-file-naming) Parameter file names are prefixed with the corresponding parameter type. A path parameter for `carrier_id` would get the following file path: ``` specification/parameters/path-carrier_id.json ``` Unique parameters can just remain in the path file and do not need to be extracted to their own files. License ------- [](#license) All software by MyParcel.com is licensed under the [MyParcel.com general terms and conditions](https://solutions.myparcel.com/legal). ### Health Score 61 — FairBetter than 98% of packages Maintenance98 Actively maintained with recent releases Popularity30 Limited adoption so far Community19 Small or concentrated contributor base Maturity83 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Recently: every ~17 days Total 319 Last Release 9d ago Major Versions v0.28.0 → v1.0.0-rc12018-12-19 ### Community Maintainers ![](https://www.gravatar.com/avatar/3841efa190ba5131014f8855131e3d38ef5ccd57c51000966348108e63c83612?d=identicon)[myparcelcom](/maintainers/myparcelcom) --- Top Contributors [![M4tini](https://avatars.githubusercontent.com/u/4649537?v=4)](https://github.com/M4tini "M4tini (875 commits)")[![yoan-myparcel](https://avatars.githubusercontent.com/u/46448148?v=4)](https://github.com/yoan-myparcel "yoan-myparcel (544 commits)")[![NickVries](https://avatars.githubusercontent.com/u/32866117?v=4)](https://github.com/NickVries "NickVries (463 commits)")[![zwaans](https://avatars.githubusercontent.com/u/83594488?v=4)](https://github.com/zwaans "zwaans (311 commits)")[![yoerriwalstra](https://avatars.githubusercontent.com/u/48599583?v=4)](https://github.com/yoerriwalstra "yoerriwalstra (188 commits)")[![Shodske](https://avatars.githubusercontent.com/u/11209396?v=4)](https://github.com/Shodske "Shodske (99 commits)")[![nessy](https://avatars.githubusercontent.com/u/881554?v=4)](https://github.com/nessy "nessy (99 commits)")[![daniel-myparcel](https://avatars.githubusercontent.com/u/193501397?v=4)](https://github.com/daniel-myparcel "daniel-myparcel (74 commits)")[![SAMDevelopment](https://avatars.githubusercontent.com/u/4527294?v=4)](https://github.com/SAMDevelopment "SAMDevelopment (67 commits)")[![dennis-koster](https://avatars.githubusercontent.com/u/8804219?v=4)](https://github.com/dennis-koster "dennis-koster (14 commits)")[![fidel404](https://avatars.githubusercontent.com/u/6574634?v=4)](https://github.com/fidel404 "fidel404 (4 commits)") ### Embed Badge ![Health badge](/badges/myparcelcom-api-specification/health.svg) ``` [![Health](https://phpackages.com/badges/myparcelcom-api-specification/health.svg)](https://phpackages.com/packages/myparcelcom-api-specification) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35916.4M7](/packages/exsyst-swagger)[hubspot/api-client Hubspot API client 24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol An implementation of the Minecraft: Bedrock Edition protocol in PHP 172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram Telegram driver for BotMan 93459.5k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)