Batch operations
Content
Resource URL
https://apps.ticketmatic.com/api/1/{accountname}/orders/batchDescription
Apply batch operations to a set of orders.
The parameters required are specific to the type of operation.
What will be affected?
The operation will be applied to the orders with given IDs. The amount of IDs is limited to 1000 per call.
ids: [1, 2, 3]
This will apply the operation to orders with ID 1, 2 and 3.
Batch operations
The following operations are supported:
emaildelivery: Send the delivery email to a selection of orders.pdf: Print a selection of orders.update: Update a specific field for the selection of orders. See BatchOrderParameters for more info.
Example
Request
1use Ticketmatic\Endpoints\Orders;
2
3Orders::batch($client, array(
4 "ids" => array(
5 1,
6 34,
7 29,
8 ),
9 "operation" => "update",
10 "parameters" => array(
11 ),
12));
Response
This operation does not return a response. The status can be checked by looking at the HTTP status code.
Request
1import (
2 "github.com/ticketmatic/tm-go/ticketmatic"
3 "github.com/ticketmatic/tm-go/ticketmatic/orders"
4)
5
6err := orders.Batch(client, &ticketmatic.BatchOrderOperation{
7 Ids: []int64{
8 1,
9 34,
10 29,
11 },
12 Operation: "update",
13 Parameters: &ticketmatic.BatchOrderParameters{
14 },
15})
Response
This operation does not return a response. The status can be checked by looking at the HTTP status code.
Request
1POST /api/1/{accountname}/orders/batch HTTP/1.1
2Content-Type: application/json
3
4{
5 "ids": [ 1, 34, 29 ],
6 "operation": "update",
7 "parameters": {
8
9 }
10}
Response
This operation does not return a response. The status can be checked by looking at the HTTP status code.
Request body fields
| Field | Description |
|---|---|
ids int[] | Restrict operation to supplied IDs, if these ids are not specified all events are updated. Example value:[ 1, 34, 29 ] |
operation string (required) | Operation to perform, possible values are: "update" |
parameters | Operation-specific parameters |
Type reference: BatchOrderOperation