Polish version: https://ordermanagerapi.mediaport.pl/api-doc-pl
The API is used to retrieve order information and generate labels.
Logging in with a username and password provided by Media Port is required.
The supplierId identifier required for API method calls must also be provided by Media Port.
The API is available at
https://ordermanagerapi.mediaport.pl/
For easier integration, a Swagger version is available at
https://ordermanagerapi.mediaport.pl/swagger/index.html
A Sandbox version is available for testing purposes
https://sandbox-ordermanagerapi.mediaport.pl/
https://sandbox-ordermanagerapi.mediaport.pl/swagger/index.html
The test user is
| username: | testapimediaport1 |
| password: | 1passapimediaport |
| supplierId: | 100 |
Orders enter the system with the status: New
Orders can be multi-item, each item in the order refers to 1 piece of product.
Until a label is generated, the order can be canceled by both the customer and the supplier.
An order has a unique order number: orderNumber. Each item in the order has its own unique item number: orderItemId.
Each API method except for the login method has the parameter supplierId.
If the supplier has many shipping locations configured (so-called child accounts), the parent supplier can generate a label for the child.
If the supplier does not have many shipping locations or works within the main account, their supplier identifier should be provided.
After retrieving information about new orders (orders method), the supplier prepares the package for shipment.
If the supplier needs to cancel an order item, it must be done before generating the label using the cancel-order-item method.
Then, for each order, the supplier generates a label (using the generate-label method) by providing the order number: orderNumber as well as a collection of order item numbers: orderItemIds.
One label is generated for the entire supplier's order for all non-canceled items.
The parameter: orderItemIds is necessary to ensure system consistency, to avoid a situation where between retrieving order information and generating a label, the order is canceled by the customer.
After generating the label, the label in PDF format should be retrieved using the get-labels method.
The protocol for the labels should be retrieved using the get-protocols method.
Labels and protocols are divided into multiple files. Each file pertains to one courier.