Child pages
  • Self provisioning - retailers only

Versions Compared

Key

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

...

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}/Pack/{id_Pack}

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:

CodeDescriptionMeaning
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

...