Page Comparison

Info

This page is a reference manual for the API to be used for developing a custom solution of automatic account provisioning. MailUp APS is built on top of this API and it should be your first option for account provisioning. As for the MailUp APS, the access to this API is not "self service", you should first contact us in order to ask for enabling your application for account provisioning and to agree on setup details.

...

the return value is the HTTP Status code of the response. API executes this operation asynchronously. Every time the client invokes the method, it returns a code. If this code tells that the operations are still in progress the resource returns an 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns 500 Internal Server Error.
the client can invoke the resource as many times as it wants.

Get retailer's customer account status

...

Description

Get retailer’s customer account status

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Status

JSON request (example)

none

JSON response (example)

Expand

Code Block

{
	"Code":0,
	"Description":"Enabled",
	"ActivePacks":[
		{"CurrentQuantity":0,"Id":534,"Quantity":0},
		{"CurrentQuantity":0,"Id":535,"Quantity":0},
		{"CurrentQuantity":0,"Id":536,"Quantity":0},
		{"CurrentQuantity":0,"Id":537,"Quantity":0},
		{"CurrentQuantity":0,"Id":538,"Quantity":0}
	],
	"Credits":300,
	"IdAccount":23053,
	"IdProfile":1401,
	"ValidFrom":"2015-10-14 22:00:00Z",
	"ValidTo":"2016-10-14 22:00:00Z"
}

Paging and filtering (example)

none

...

Description

Add package to retailer's customer account

HTTP Method

POST

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}

JSON request (example)

Expand

Incremental:

Code Block
{ "Quantity":-3, "WorkMode":"incremental" }

Absolute:

Code Block
{ "Quantity":3, "WorkMode":"absolute" }

JSON response (example)

Expand

Code Block
{ "Code":0, "Description":"Ok" }

The resource returns a 200 OK status code if the package was added succesfully and the response contains code = 0; if the addition does not end propertly, the resource returns a 403 Forbidden and the response contains:

Code	Description	Meaning
1	Quantity limits exceeded	The number of packages you are trying to add/remove exceeds the profile limits
2	Profile rules error	The number of packages you are trying to add/remove exceeds some profile rule limit (for example, you cannot remove a package related to SMS)
3	Invalid quantity	This error condition appears when the work mode equals to “absolute” and the quantity value is negative
4	Invalid workmode	The WorkMode field should be “incremental” or “absolute” ONLY

Paging and filtering (example)

none

...

Versions Compared

Old Version 33

New Version 34

Key

Get retailer's customer account status