List terminal orders | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.Boarding.ProcessingAccounts;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new PayrocClient();
        await client.Boarding.ProcessingAccounts.ListTerminalOrdersAsync(
            new ListTerminalOrdersProcessingAccountsRequest {
                ProcessingAccountId = "38765"
            }
        );
    }
}

1	[
2	{
3	"terminalOrderId": "12345",
4	"status": "open",
5	"orderItems": [
6	{
7	"solutionTemplateId": "Roc Services_DX8000",
8	"type": "solution",
9	"deviceCondition": "new",
10	"links": [
11	{
12	"processingTerminalId": "1234001",
13	"link": {
14	"href": "https://api.payroc.com/v1/processing-terminals/1234001",
15	"rel": "processingTerminal",
16	"method": "get"
17	}
18	}
19	],
20	"solutionQuantity": 1,
21	"solutionSetup": {
22	"timezone": "America/Chicago",
23	"industryTemplateId": "Retail",
24	"gatewaySettings": {
25	"merchantPortfolioId": "Company Ltd",
26	"merchantTemplateId": "Company Ltd Merchant Template",
27	"userTemplateId": "Company Ltd User Template",
28	"terminalTemplateId": "Company Ltd Terminal Template"
29	},
30	"applicationSettings": {
31	"clerkPrompt": false,
32	"security": {
33	"refundPassword": true,
34	"keyedSalePassword": false,
35	"reversalPassword": true
36	}
37	},
38	"deviceSettings": {
39	"numberOfMobileUsers": 2,
40	"communicationType": "wifi"
41	},
42	"batchClosure": {
43	"batchCloseType": "automatic",
44	"batchCloseTime": "23:40"
45	},
46	"receiptNotifications": {
47	"emailReceipt": true,
48	"smsReceipt": false
49	},
50	"taxes": [
51	{
52	"taxRate": 6,
53	"taxLabel": "Sales Tax"
54	}
55	],
56	"tips": {
57	"enabled": false
58	},
59	"tokenization": true
60	}
61	}
62	],
63	"createdDate": "2024-07-02T12:00:00.000Z",
64	"lastModifiedDate": "2024-07-02T12:00:00.000Z",
65	"trainingProvider": "payroc",
66	"shipping": {
67	"preferences": {
68	"method": "nextDay",
69	"saturdayDelivery": true
70	},
71	"address": {
72	"recipientName": "Recipient Name",
73	"addressLine1": "1 Example Ave.",
74	"city": "Chicago",
75	"state": "Illinois",
76	"postalCode": "60056",
77	"email": "[email protected]",
78	"businessName": "Company Ltd",
79	"addressLine2": "Example Address Line 2",
80	"phone": "2025550164"
81	}
82	}
83	}
84	]

Use this method to return a paginated list of terminal orders associated with a processing account.

Note: If you want to view the details of a specific terminal order and you have its terminalOrderId, use our Retrieve Terminal Order method.

Use the query parameters to filter the list of results that we return, for example, to search for terminal orders by their status.

To list the terminal orders for a processing account, you need its processingAccountId. If you don’t have the processingAccountId, use our List Merchant Platforms method to search for a merchant platform and its processing accounts.

Our gateway returns the following information for each terminal order in the list:

Status of the order
Items in the order
Training provider
Shipping information

For each terminal order, we also return its terminalOrderId, which you can use to perform follow-on actions.

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of terminal orders associated with a processing account. **Note:** If you want to view the details of a specific terminal order and you have its terminalOrderId, use our [Retrieve Terminal Order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve) method. Use the query parameters to filter the list of results that we return, for example, to search for terminal orders by their status. To list the terminal orders for a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for a merchant platform and its processing accounts. Our gateway returns the following information for each terminal order in the list: - Status of the order - Items in the order - Training provider - Shipping information For each terminal order, we also return its terminalOrderId, which you can use to perform follow-on actions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingAccountIdstringRequired

Unique identifier that we assigned to the processing account.

Query parameters

statusenumOptional

Filter terminal orders by status.

Allowed values:

fromDateTimedatetimeOptional

toDateTimedatetimeOptional

Response

Successful request. Returns a list of terminal orders associated with the processing account.

terminalOrderIdstring

Unique identifier that we assigned to the terminal order.

statusenum

Status of the terminal order.

Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Event Subscriptions.

Allowed values:

orderItemslist of objects

Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.

createdDatedatetimeRead-only

Date that we received the terminal order. We return this value in the ISO-8601 format.

Date that we received the terminal order. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

lastModifiedDatedatetimeRead-only

Date that the terminal order was last changed. We return this value in the ISO-8601 format.

Date that the terminal order was last changed. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

trainingProviderenumDefaults to partner

Indicates who provides training to the merchant for the solution.

Allowed values:

shippingobject

Object that contains the shipping details for the terminal order. If you don’t provide a shipping address, we use the Doing Business As (DBA) address of the processing account.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error