Versions Compared

Old Version 26

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 27

changes.mady.by.user MailUp Dev Team

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page:

...

  1. 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.

  2. the client can invoke the resource as many times as it wants.

Get retailer's customer account status

...

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:

CodeDescription
1

Quantity limits exceeded

2

Profile rules error

3

Invalid quantity

4

Invalid workmode


 

 

 

Paging and filtering (example)

none

...

Description

Get retailer's customer account login url

HTTP Method

GET

URL

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

JSON request (example)

none

JSON response (example)

Expand
Code Block
"http:\/\/mailup_trial.mailadmin.io\/Console\/Login.aspx?Code=2f3g3m0G2K3L1B242A1f412E0a2118373c1T1f0e1F39452a373z2P2h0n0Z3L3a2j3H2707350C3j030L3Y0O3t1A2y4032373Q3c0S2O3F1I343I0g3O0b3d050L1m-1r2K1C01041D3F013e2A0E1X3b1T3a0W1H4128020k0z0R180P053b3j1r3G152C"

Paging and filtering (example)

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Login?PageSize=2&PageNumber=1none

Errors

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails