Merchant

Resource 'Merchant' operations.

Retrieves the collection of Merchant resources.

Retrieves the collection of Merchant resources.

Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

Merchant collection

403

Forbidden

get/mf2/merchants
Request samples 
Response samples 
[
  • {
    }
]
Creates a Merchant resource.
Creates a Merchant resource.


Request 
Request Body schema: 
required
The new Merchant resource


vat_number
required
string  = 11 characters ^(\d+)$
The VAT number of the merchant (Partita IVA).


 
fiscal_code
string  = 11 characters ^(\d+)$
The Fiscal Code of the merchant (Codice Fiscale).


 
business_name
string or null
The business name of the merchant (Ragione sociale).


 
first_name
string or null
The first name of the merchant, in case there is no business name.


 
last_name
string or null
The last name of the merchant, in case there is no business name.


 
email
required
string <email> 
The email address.


 
https://schema.org/email
password
required
string^((?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#$...
The password.


 
required
object (A-Cube_GOV-IT_PEL_Platform_Address) 
 
Responses 
201
Merchant resource created


400
Invalid input


403
Forbidden


422
An error occurred


post/mf2/merchants
Request samples 
{
  • "vat_number": "stringstrin",
  • "fiscal_code": "stringstrin",
  • "business_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "address": {
    }
}
Response samples 
{
  • "uuid": "string",
  • "vat_number": "string",
  • "fiscal_code": "string",
  • "email": "string",
  • "business_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "address": {
    }
}
Retrieves a Merchant resource.
Retrieves a Merchant resource.


Request 
path Parameters
uuid
required
string
The uuid of the Merchant


 
Responses 
200
Merchant resource


403
Forbidden


404
Not found


get/mf2/merchants/{uuid}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "vat_number": "string",
  • "fiscal_code": "string",
  • "email": "string",
  • "business_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "address": {
    }
}
Replaces the Merchant resource.
Replaces the Merchant resource.


Request 
path Parameters
uuid
required
string
The uuid of the Merchant


 
Request Body schema: 
required
The updated Merchant resource


business_name
string or null
The business name of the merchant (Ragione sociale).


 
first_name
string or null
The first name of the merchant, in case there is no business name.


 
last_name
string or null
The last name of the merchant, in case there is no business name.


 
A-Cube_GOV-IT_PEL_Platform_Address (object) or null
 
Responses 
200
Merchant resource updated


400
Invalid input


403
Forbidden


404
Not found


422
An error occurred


put/mf2/merchants/{uuid}
Request samples 
{
  • "business_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "address": {
    }
}
Response samples 
{
  • "uuid": "string",
  • "vat_number": "string",
  • "fiscal_code": "string",
  • "email": "string",
  • "business_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "address": {
    }
}