> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Preview an order > Checks an order body without creating the order. Send the same body as create order. No order is created, and the response holds only an empty `activity_logs` under `order`. A body that names a new account still creates that account. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload. ## OpenAPI ````yaml POST /orders/preview openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /orders/preview: post: tags: - Orders summary: Preview an order description: >- Send the same body as create order. No order is created, and the response holds only an empty `activity_logs` under `order`. A body that names a new account still creates that account. operationId: orders_preview_order parameters: [] requestBody: required: true content: application/json: schema: type: object properties: order: type: object properties: account_id: type: string description: The account's `id`, such as `ACC0001`. name: type: string lines: type: array items: type: object properties: item_id: type: string description: The item's `id`. item_order_quantity: type: integer item_custom_attributes: type: array items: type: object properties: name: type: string value: type: string allow_contract: type: boolean description: >- `true` makes the order a contract. A contract needs a recurring or metered item on a line. contract_properties: type: object properties: initial_contract_term: type: string description: Such as `1 Year`. renew_automatically: type: boolean auto_renewal_term: type: string allow_trial: type: boolean allow_early_termination: type: boolean require_customer_acceptance: type: boolean start_contract_after_trial_ends: type: boolean trial_start_date: type: string trial_end_date: type: string trial_requires_payment_method: type: boolean properties: type: object properties: invoice_mode: type: string invoice_term: type: string billing_period: type: string payment_processor: type: string payment_mode: type: string payment_term: type: string payment_term_alignment: type: string fulfillment_mode: type: string fulfillment_term: type: string description: >- Billing preferences for the order; they are read back under `billing_preferences`. custom_attributes: type: array items: type: object properties: name: type: string value: type: string invoice_note: type: string price_tax_inclusive: type: boolean billing_address: type: object properties: address_line_1: type: string address_line_2: type: string city: type: string state: type: string post_code: type: string country: type: string description: A country code such as `AU`. shipping_address: type: object properties: address_line_1: type: string address_line_2: type: string city: type: string state: type: string post_code: type: string country: type: string description: A country code such as `AU`. pre_order: type: boolean billing_start_date: type: string description: Such as `ORDER_ACTIVATION_DATE` for a pre-order. quote_order: type: boolean description: '`true` creates a quote instead of a regular order.' required: - order example: order: account_id: ACC0001 name: Acme Pty Ltd monthly order lines: - item_id: ITEM-0001 item_order_quantity: 1 responses: '201': description: The preview, under `order`. x-codeSamples: - lang: bash label: cURL source: |- curl -X POST "$EXSITED_BASE_URL/api/v4/orders/preview" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "order": { "account_id": "ACC0001", "name": "Acme Pty Ltd monthly order", "lines": [ { "item_id": "ITEM-0001", "item_order_quantity": 1 } ] } }' - lang: python label: Python source: | from exsited import build_client client = build_client() response = client.orders.preview_order( { "order": { "account_id": "ACC0001", "name": "Acme Pty Ltd monthly order", "lines": [{"item_id": "ITEM-0001", "item_order_quantity": 1}], } } ) print(response.data) - lang: javascript label: JavaScript source: | import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.orders.previewOrder({ order: { account_id: 'ACC0001', name: 'Acme Pty Ltd monthly order', lines: [{item_id: 'ITEM-0001', item_order_quantity: 1}], }, }); console.log(response.data); - lang: php label: PHP source: | use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->orders->previewOrder([ 'order' => [ 'account_id' => 'ACC0001', 'name' => 'Acme Pty Ltd monthly order', 'lines' => [['item_id' => 'ITEM-0001', 'item_order_quantity' => 1]], ], ]); print_r($response->data); - lang: java label: Java source: | import com.exsited.Dto; import com.exsited.client.ApiResponse; import com.exsited.client.ClientRegistry; import com.exsited.client.ExsitedClient; import java.util.List; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.orders().previewOrder( Map.of( "order", Map.of( "account_id", "ACC0001", "name", "Acme Pty Ltd monthly order", "lines", List.of(Map.of("item_id", "ITEM-0001", "item_order_quantity", 1))))); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.Orders.PreviewOrderAsync(new Dictionary { ["order"] = new Dictionary { ["account_id"] = "ACC0001", ["name"] = "Acme Pty Ltd monthly order", ["lines"] = new List { new Dictionary { ["item_id"] = "ITEM-0001", ["item_order_quantity"] = 1, }, }, }, }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.orders.previewOrder({ 'order': { 'account_id': 'ACC0001', 'name': 'Acme Pty Ltd monthly order', 'lines': [ {'item_id': 'ITEM-0001', 'item_order_quantity': 1}, ], }, }); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Orders().PreviewOrder(context.Background(), map[string]any{\n\t\"order\": map[string]any{\n\t\t\"account_id\": \"ACC0001\",\n\t\t\"name\": \"Acme Pty Ltd monthly order\",\n\t\t\"lines\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"item_id\": \"ITEM-0001\",\n\t\t\t\t\"item_order_quantity\": 1,\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.