Download the PHP package xi0s/royal-mail-php-api without Composer
On this page you can find all versions of the php package xi0s/royal-mail-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package royal-mail-php-api
Royal Mail v4 Pro Shipping API client
This PHP package is automatically generated by the Swagger Codegen project:
- API version: v4.0-RM
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
Requirements
PHP 7.4 and later
Installation & Usage
Composer
Then run composer install xi0s/royal-mail-php-api
Tests
To run the unit tests:
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Endpoints
All URIs are relative to https://api.proshipping.net/
Class | Method | HTTP request | Description |
---|---|---|---|
OfflineBarcodingApi | v4OfflineBarcodeNumberRangeRmPost | POST /v4/offlineBarcodeNumberRange/rm | Get Barcode Range |
ShipmentsApi | v4ShipmentsDeferPut | PUT /v4/shipments/defer | Defer Shipments |
ShipmentsApi | v4ShipmentsPreallocateTrackingNumberRmPost | POST /v4/shipments/preallocateTrackingNumber/rm | Pre Allocate Tracking Number |
ShipmentsApi | v4ShipmentsPrintDocumentCarrierCodeShipmentIdPost | POST /v4/shipments/printDocument/{carrierCode}/{shipmentId} | Print Document |
ShipmentsApi | v4ShipmentsPrintLabelRmShipmentIdGet | GET /v4/shipments/printLabel/rm/{shipmentId} | Print Label |
ShipmentsApi | v4ShipmentsPrintMyLabelQRCodeRmShipmentIdGet | GET /v4/shipments/printMyLabelQRCode/rm/{shipmentId} | Print My Label QR Code |
ShipmentsApi | v4ShipmentsRmPost | POST /v4/shipments/rm | Create Shipment |
ShipmentsApi | v4ShipmentsShippingLocationIdGet | GET /v4/shipments/{shippingLocationId} | Get Shipments |
ShipmentsApi | v4ShipmentsStatusPut | PUT /v4/shipments/status | Update Status |
ShippingAccountsApi | v4ShippingAccountsCarrierCodeShippingAccountIdDelete | DELETE /v4/shippingAccounts/{carrierCode}/{shippingAccountId} | Delete Account |
ShippingAccountsApi | v4ShippingAccountsCarrierCodeShippingAccountIdUnlinkLocationsPut | PUT /v4/shippingAccounts/{carrierCode}/{shippingAccountId}/unlinkLocations | Unlink Locations |
ShippingAccountsApi | v4ShippingAccountsGet | GET /v4/shippingAccounts | Get Accounts |
ShippingAccountsApi | v4ShippingAccountsRmGet | GET /v4/shippingAccounts/rm | Get Carrier Accounts |
ShippingAccountsApi | v4ShippingAccountsRmPost | POST /v4/shippingAccounts/rm | Add Account |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdGet | GET /v4/shippingAccounts/rm/{shippingAccountId} | Get Account |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdLinkLocationsPost | POST /v4/shippingAccounts/rm/{shippingAccountId}/linkLocations | Link Locations |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdPut | PUT /v4/shippingAccounts/rm/{shippingAccountId} | Update Account |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdShippingLocationsGet | GET /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations | Get Associated Locations |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdShippingLocationsShippingLocationIdGet | GET /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations/{shippingLocationId} | Get Associated Location |
ShippingAccountsApi | v4ShippingAccountsRmShippingAccountIdShippingLocationsShippingLocationIdPut | PUT /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations/{shippingLocationId} | Update Associated Location |
Documentation For Models
- AccountType
- AddShippingAccountLocationNewLocation
- AddShippingAccountResponse
- BusinessTransactionType
- ContentType
- CreateCollectionRequest
- CreateCollectionResponse
- CreateShipmentAction
- Customs
- DeferShipmentRequest
- Destination
- DestinationDetails
- Dimensions
- DimensionsUnitOfMeasure
- DocumentFormat
- DocumentType
- ErrorDetail
- ErrorResponse
- GetShipmentsStatusType
- Item
- OrderDirection
- PreAllocateTrackingNumberRequest
- PreAllocateTrackingNumberResponse
- PrintDocumentRequest
- PrintDocumentResponse
- QRCodeResponse
- ReturnToSender
- RoyalMailAccountLocationStatus
- RoyalMailAddShippingAccountLocation
- RoyalMailAddShippingAccountRequest
- RoyalMailDataStreamDetails
- RoyalMailEnhancementCode
- RoyalMailGazetteerCodes
- RoyalMailGetOfflineBarcodingRequest
- RoyalMailGetOfflineBarcodingResponse
- RoyalMailLabelFormat
- RoyalMailLabelFormatRoyalMailShipmentResponseCarrierSpecificsPackageResponseCreateShipmentResponse
- RoyalMailLabelFormatRoyalMailShipmentResponseCarrierSpecificsPrintLabelResponse
- RoyalMailLabelFormatShipmentInformation
- RoyalMailLinkShippingAccountLocation
- RoyalMailOfflineBarcode
- RoyalMailOfflineBarcodingEnhancementCode
- RoyalMailPackage
- RoyalMailPackageTypeCode
- RoyalMailPreAllocatedTrackingNumberEnhancementCode
- RoyalMailServiceEnhancement
- RoyalMailShipmentRequestCarrierSpecifics
- RoyalMailShipmentRequestCarrierSpecificsRoyalMailPackageRoyalMailLabelFormatCreateShipmentRequest
- RoyalMailShipmentResponseCarrierSpecifics
- RoyalMailShipmentResponseCarrierSpecificsPackageResponse
- RoyalMailShippingAccount
- RoyalMailShippingAccountShippingAccountsPagedResponse
- RoyalMailUpdateShippingAccountLocation
- RoyalMailUpdateShippingAccountRequest
- RoyalMailViewShippingAccountLocation
- RoyalMailViewShippingAccountLocationShippingLocationForAccount
- RoyalMailViewShippingAccountLocationShippingLocationsForAccountPagedResponse
- ShipmentAddress
- ShipmentResponse
- ShipmentsPagedResponse
- Shipper
- ShipperAddress
- ShippingAccount
- ShippingAccountsPagedResponse
- ShippingAccountsSortBy
- ShippingLocationAddress
- ShippingLocationIdRequest
- ShippingLocationsSortBy
- TermsOfTrade
- UpdateStatusRequest
- UpdateStatusType
- WeightUnitOfMeasure
Documentation For Authorization
oauth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
Author
All versions of royal-mail-php-api with dependencies
PHP Build Version
Package Version
Requires
php Version
^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
The package xi0s/royal-mail-php-api contains the following files
Loading the files please wait ....