POST /orders/merchantMaintenance
Create an internal merchant maintenance order to track the workflow related to a merchant maintenance request such as updating a trading address. This should only be used by the order service consumer after a change has been done to entity service and additional workflow steps are required to orchestrate this data to other systems.
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
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 |
|---|---|---|---|
modifiedDate |
String | No |
The last modified date for this order. |
status |
String | Yes |
An order will be in one of the following states Valid values:
|
createdDate |
String | No |
The created date for this order. |
modifiedBy |
String | No |
The username of the person who's UID is represented, e.g. "John/Jane Smith". |
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" |
orderId |
String | Yes |
Verifone allocated ID for the Order |
notes |
String | No |
Notes for the Order |
orderType |
String | No |
Default value: "MerchantMaintenanceOrder" |
orderReference |
String | Yes |
Client reference for the Order |
requestedDate |
String | No |
The requested date for this order. |
eventType |
String | Yes |
Valid values:
|
poRef |
String | No |
Purchase Order Reference |
modifiedUserUid |
String | No |
The assigned User_ID corresponding to the Order Modified By. |
createdUserUid |
String | No |
The assigned User_ID corresponding to the Order Created By. |
entityUid |
String | Yes |
The Verifone allocated unique id for this site. |
content |
Object | No | |
itemId |
String | Yes |
The ID of the record associated to the event. |
merchant |
Object | No |
Simple Wrapper object for Merchant Name.Used by UI |
merchant.merchantName |
String | No |
The primary merchant name, e.g. "McDonalds". |
createdBy |
String | No |
The username of the person who's UID is represented, e.g. "John/Jane Smith". |
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.