POST /pois/orders/maintenance/{poiUid}
Submits a POI Maintenance Order Request
Servers
- https://emea.gsc.verifone.cloud/oidc/order-service
- https://us.gsc.verifone.cloud/oidc/order-service
- https://nz.gsc.verifone.cloud/oidc/order-service
- https://cst.test-gsc.vfims.com/oidc/order-service
- https://uscst-gb.gsc.vficloud.net/oidc/order-service
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
poiUid |
String | Yes |
The assigned ID corresponding for the POI. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
paymentDetails |
Object | No |
Details of how the order will be paid, and the further re-occuring billing for services. |
paymentDetails.paymentType |
String | Yes |
Type of payment that can be made. Default value: "CREDIT" |
maintenanceType |
String | Yes |
Valid values:
|
notes |
String | No |
Notes for the Order |
deliveryPackage |
Object | No | |
deliveryPackage.additionalPackageData[] |
Array | No |
Input data required to configure the package. For example some packages require a merchant ID |
deliveryPackage.additionalPackageData[].variableName |
String | No |
Variable name (this would be provided by Verifone) |
deliveryPackage.additionalPackageData[].variableValue |
String | No |
Value of the variable |
deliveryPackage.packageBundleId |
String | Yes |
The Verifone allocated ID for the package bundle. |
orderReference |
String | Yes |
Client reference for the Order |
requestedDate |
String | No |
The requested date for this order. |
poRef |
String | No |
Purchase Order Reference |
customerEntityUid |
String | Yes |
Verifone allocated ID for the customer this order is for (packages and bundles are associated with this entity). |
additionalOrderData[] |
Array | No |
Input data which maybe required for the country/business unit to to complete the order. For example some countries require a VAT ID, or different legal forms of business, this will be defined by Verifone if needed for your integration |
additionalOrderData[].variableName |
String | No |
Variable name (this would be provided by Verifone) |
additionalOrderData[].variableValue |
String | No |
Value of the variable |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.