GET /orders
By passing in the appropriate options, you can search for available orders in the system
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
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filterDateType |
String | No |
pass an optional search string for filtering based on date type. Otherwise this will default to createdDate Valid values:
Default value: "createdDate" |
merchantCompanyEntityUid |
String | No |
The Verifone assigned ID corresponding to the Merchant Company. |
detailedStatus |
String | No |
pass an optional search string for looking up order by detailed status Valid values:
|
merchantType[] |
Array | No |
Merchant type for the orders |
status |
String | No |
pass an optional search string for looking up order by status Valid values:
|
lastChangeTime |
String | No |
Orders last changed before this time (used to find order not moved) |
endTime |
String | No |
The record date/time to search to. |
merchantCompany |
String | No |
The merchant company. |
startTime |
String | No |
The record date/time to search from. |
order |
String | No |
The order direction. Valid values:
|
signingProvider |
String | No |
The signing provider for the order. Valid fields are: ADOBE, SIGNICAT, DOKOBIT Valid values:
|
orderType |
String | No |
pass an optional search string for looking up order by type. Otherwise this will default to MerchantOrder Valid values:
Default value: "MerchantOrder" |
orderReference |
String | No |
Optional search string for looking up order by ID |
pageNumber |
Integer | No |
Page number for records. Default value: 1 |
orderBy |
String | No |
The field to order by. Valid fields are: createdBy, createdDate, modifiedDate, merchantName, status |
pageSize |
Integer | No |
Page size for returned records. Default value: 50 |
userUids[] |
Array | No |
List of the User_ID corresponding to the User who created or modified the order. |
customerEntityUid |
String | No |
The estate customer entity UUID for the portfolio. |
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.