Applications
ch:applications
LINK RELATION
,
EMBEDDED RELATION
Actions
| method | description |
|---|---|
| GET | View applications collection |
| POST1 | Create new application |
| OPTIONS | Retrieve supported HTTP methods |
1
It is possible to supply a json file with full application data (except data about files; see File handling). See Application JSON for a full example.
Request parameters
| property | type | required | method |
|---|---|---|---|
| signer.name | string | false | POST |
| signer.email1 | false | POST | |
| business_model.trading_name | string | true | POST |
| business_model.description | string | true | POST |
| business_model.recurring | boolean | true | POST |
| business_model.physical_delivery | boolean | true | POST |
| business_model.delivery_delay2 | string | false | POST |
| business_model.drop_shipping | boolean | false | POST |
| business_model.estimate_currency | ISO 4217 3-letter code | true | POST |
| business_model.estimated_monthly_turnover | decimal(19,4) | true | POST |
| business_model.estimated_average_transaction_amount | decimal(19,4) | true | POST |
| additional_information | text | false | POST |
| query3 | string | false | GET |
| page4 | integer | false | GET |
| per_page4 | integer | false | GET |
1
Required if
signer.name is set.
2
One of:
less5days, 5to10days, 10to20days, more20days. Required if business_model.physical_delivery is true.
3
See Application Query Language (APQL) for details.
4
See Pagination for details.
Profile
The Applications resource represents a collection of Application resources.
Properties
| name | type | read-only |
|---|---|---|
| count | integer | true |
| page | integer | true |
| per_page | integer | true |
Link relations
| rel | conditional |
|---|---|
| self | false |
| first | true |
| last | true |
| prev | true |
| next | true |
Embedded
Additional semantics
This collection is paginated. See Pagination.
This collection supports Application Query Language (APQL).
Example representation
{
"count": 1,
"page": 1,
"per_page": 20,
"_links": {
"self": {
"href": "https://merchant.test.clearhaus.com/applications"
},
"curies": [
{
"href": "https://developer.clearhaus.com/rels/{rel}",
"templated": true,
"name": "ch"
}
]
},
"_embedded": {
"ch:applications": [...]
}
}