v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Common

Get the list of the creators for the orders

By passing in the appropriate options, you can search for creators based upon the search criteria.

get/orders/creators

Query parameters

orderReferencestring

Optional search string for looking up order by ID.

status'DRAFT' | 'SUBMITTED' | 'INPROGRESS' | 'COMPLETED' | 'CANCELLED' | 'ONHOLD'

Pass an optional search string for looking up order by status.

orderType'POIOrder' | 'MerchantOrder' | 'POIMaintenanceOrder' | 'MerchantMaintenanceOrder' | 'POIAccessoryOrder' | 'AdditionalServicesOrder' | 'HardwareOrder'

pass an optional search string for looking up order by type. Defaults to MerchantOrder.

filterDateType'createdDate' | 'modifiedDate'

The filter by date type.

Pass an optional search string for filtering based on date type. Otherwise this will default to createdDate.

userUidsstring[]

List of the User ID corresponding to the User who created or modified the order.

startTimestring date-time

The record date/time to search from.

endTimestring date-time

The record date/time to search to.

merchantCompanystring

The primary merchant name, e.g. "McDonalds".

The merchant company.

merchantCompanyEntityUidstring uuid

The Verifone allocated unique ID for this merchant company.

The Verifone assigned ID corresponding to the Merchant Company.

merchantCompanyEntityUidsMerchantCompanyEntityUid[]

The Verifone assigned IDs corresponding to the Merchant Company.

customerEntityUidsEntityUid[]

The estate customer entity UUIDs for the portfolio.

customerEntityUidstring uuid

The Verifone allocated unique id for this site.

The estate customer entity UUID for the portfolio.

Response

Search results matching criteria.