> For the complete documentation index, see [llms.txt](https://userguide.zappost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://userguide.zappost.com/zap-api/api-endpoints/transactions.md).

# Transactions

The transaction endpoint serves as a data collection point for transactional data that is used in ZAP processes such as ROAS Reporting. \
You can find out more about ROAS by reading the documentation [here](https://userguide.zappost.com/zap-post-web-app/zap-post-user-guide/zap-app/using-the-zapp/insights.md#roas-reporting)

## POST /api/v2/Transactions

> For more information visit the \<a href="<https://userguide.zappost.com/zap-api/api-endpoints/transactions>" target="\_blank">documentation\</a>

```json
{"openapi":"3.0.1","info":{"title":"ZAPI","version":"1.0.0"},"security":[{"Basic":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic"}},"schemas":{"TransactionRequest":{"required":["transactions"],"type":"object","properties":{"sourcePlatformName":{"type":"string","nullable":true},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"nullable":true}},"additionalProperties":false},"Transaction":{"required":["customerEmail","customerId","orderCurrencyCode","orderDate","orderReference","orderValue"],"type":"object","properties":{"orderReference":{"type":"string","nullable":true},"customerId":{"type":"string","nullable":true},"orderDate":{"type":"string","format":"date-time"},"orderValue":{"type":"number","format":"double"},"orderNetValue":{"type":"number","format":"double","nullable":true},"orderTaxValue":{"type":"number","format":"double","nullable":true},"orderCurrencyCode":{"type":"string","nullable":true},"orderDiscountCode":{"type":"string","nullable":true},"customerEmail":{"type":"string","nullable":true},"customerBillingAddress":{"required":["addressLine1","postalCode"],"allOf":[{"$ref":"#/components/schemas/TransactionAddress"}],"nullable":true},"customerShippingAddress":{"required":["addressLine1","postalCode"],"allOf":[{"$ref":"#/components/schemas/TransactionAddress"}],"nullable":true}},"additionalProperties":false},"TransactionAddress":{"required":["addressLine1","postalCode"],"type":"object","properties":{"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"addressLine3":{"type":"string","nullable":true},"addressLine4":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/v2/Transactions":{"post":{"tags":["RoasTransactions"],"description":"For more information visit the <a href=\"https://userguide.zappost.com/zap-api/api-endpoints/transactions\" target=\"_blank\">documentation</a>","requestBody":{"content":{"application/json":{"schema":{"required":["transactions"],"allOf":[{"$ref":"#/components/schemas/TransactionRequest"}]}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"429":{"description":"Too Many Requests"},"500":{"description":"Server Error"}}}}}}
```

<table><thead><tr><th width="290">Property</th><th width="284">Mandatory</th></tr></thead><tbody><tr><td>Order Reference</td><td>Yes</td></tr><tr><td>Customer ID</td><td>Yes</td></tr><tr><td>Order Date</td><td>Yes</td></tr><tr><td>Order Value</td><td>Yes</td></tr><tr><td>Order Net Value</td><td>No</td></tr><tr><td>Order Tax Value</td><td>No</td></tr><tr><td>Order Currency Code</td><td>Yes</td></tr><tr><td>Order Discount Code</td><td>No</td></tr><tr><td>Customer Email</td><td>Yes</td></tr><tr><td>Customer Billing Address</td><td>No</td></tr><tr><td>Customer Shipping Address</td><td>No</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://userguide.zappost.com/zap-api/api-endpoints/transactions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
