There is a WADL document available that describes the resources API.
name | path | methods | description |
---|---|---|---|
Authentication API |
|
|
This API allows customers to log in (either manually with a password or through the so-called "soft-login"), change customer information, look at order history, track parcels and more. |
Customer API |
|
|
The customer object is the most central resource of the "My pages" API. |
Offer API |
|
|
Provides methods for managing offers for customers that are logged in to the "My pages" API. |
Order API |
|
|
Provides methods for managing orders for customers that are logged in to the "My pages" API. |
Reset password API |
|
|
It's not rare that consumers lose their passwords. This API provides a safe way for consumers to reset their passwords. ETM never sets the passwords, instead a token will be generated. This token will be sent out to the consumer (most commonly using an e-mail). By following a link, the consumer can then enter the new password themselves. |
type | description |
---|---|
Address | Information about a geographical address. |
AuthenticationRequest | Defines a request to authenticate a customer to the "My pages" API by providing an identifier (for example an email address) and a password, among other things. |
Credentials | Holds customer credentials for authenticating to "My pages". |
Customer | A customer is the central part of ETM. It holds information required to communicate with the customer and holds shipping information for the customer. |
LocalAddress | Information about a local geographical address. A local address means that it has no awareness of country. |
MyPagesParcelStatus | |
Offer | An MyPagesOffer defines an offer connected against a customer category
A customer can be connected to several customer categories |
Order | |
OrderRow | A orderrow defines a row from a purchase
Each order contains one or several rows |
OrderStatus | |
Parcel | |
ParcelTimeLine | |
RegisterCustomer | Contains information for registering a customer into the system. |
ResetPasswordRequest | Contains information for requesting a new reset password token. |
SetPasswordRequest | Contains the new password that will be set for a customer. Notice that we only accept a single password value here, so it is recommended to perform a confirmation check on the API client side before passing it to this API. |
Store | |
UpdateCustomer | Contains information for updating a customer. To not update certain fields, simply do not send then. |
UpdatePassword | Contains information for updating the customer password. To update the customer password, the current password is required. |