---
title: Book
url: 'https://documentation.netstorming.net/api-reference/activities/book'
markdown: 'https://documentation.netstorming.net/api-reference/activities/book.md'
date: '2026-06-15'
description: 'Book Product: activity Type: book Book the selected agreement. Request Request fields: search @number: search number from previous availability search agreement @code: selected agreement code from previous availability search reference @code: your booking reference. Must be UN…'
taxonomy:
  category:
    - docs
---

# Book

[](#)  [ API reference ](https://documentation.netstorming.net/api-reference)     [ Activities ](https://documentation.netstorming.net/api-reference/activities)      Book    

#### Book

Product: **activity**
Type: **book**

Book the selected agreement.

##### Request

Request fields:

- **search**
- - **@number**: search number from previous availability search
- **agreement**
- - **@code**: selected agreement code from previous availability search
- **reference**
- - **@code**: your booking reference. Must be UNIQUE
- **paxes**
- - **pax**
- - - **@leader**: leader is a "reference" passenger. Every booking must have exactly one leader.
- - - **@title**: MR, MS, MRS
- - - **@name**: traveller's name
- - - **@surname**: traveller's surname
- - - **@age**: traveller's age
- - - **@email**: traveller's email address
- - - **@phone**: traveller's phone number (without international prefix)
- - - **@phone\_prefix**: phone number international prefix (according to the ITU standard, e.g. +39 for Italy)
- - - **@country**: traveller's nationality ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))
- **additional\_fields**
- - **additional\_field**
- - - **@code**: additional field code
- - - **@value**: additional field value

Request example:

```
<envelope>
    <header>
        <actor>exampleactor</actor>
        <user>exampleuser</user>
        <password>*****</password>
        <version>1.7.0</version>
        <timestamp>20260612150441</timestamp>
    </header>
    <query type="book" product="activity">
        <search number="activities.avl6a2bf9ea7090f"/>
        <agreement code="0x0e8.E-E10-A0BCNO0033-33834358#TOUR.ODQxZGE5"/>
        <reference code="t20013101204s426d3"/>
        <paxes>
            <pax leader="true" title="MS" name="test" surname="Example" email="example@netstorming.net" phone="00390418870080" country="IT"/>
            <pax leader="false" title="" name="" surname="" />
            <pax leader="false" title="" name="" surname="" age="5"/>
            <pax leader="false" title="" name="" surname="" age="8"/>
        </paxes>
        <additional_fields>
            <additional_field code="start_time" value="11:00" />
            <additional_field code="activity_language" value="en" />
        </additional_fields>
     </query>
</envelope>
```

##### Response

Response example:

```
<envelope>
    <header>
        <version port="22222" host="example.netstorming.office">1.7.0</version>
        <timestamp>20260512150541</timestamp>
    </header>
    <response type="book" product="activity">
        <supplier code="TEST_SUPP" reference="B0626ZAAFR">TEST SUPPLIER NAME</supplier>
        <booking code="B0626HU5YV"/>
        <reference code="t20013101204s426d3"/>
        <status code="CNF"/>
        <deadline date="2026-07-21 00:00:00"/>
        <start date="2026-06-25" time="11:00"/>      
        <language code="en"/>
        <paxes number="4">
             <pax title="MS" name="test" surname="gio" email="" leader="true"/>
            <pax title="" name="" surname="" email="" country="" leader="false"/>
            <pax title="" name="" surname="" email="" country="" leader="false" age="5"/>
            <pax title="" name="" surname="" email="" country="" leader="false" age="8"/>
        </paxes>
        <activity_info>
            ...
        </activity_info>
        <additional_fields>
            <additional_field code="start_time" name="starting time" value="11:00"/>
            <additional_field code="activity_language" name="activity language" value="en"/>
        </additional_fields>
        <remarks/>
        <prices>
            <nett amount="1113" currency="USD"/>
            <gross amount="1115" currency="USD"/>
        </prices>
        <voucher url="https://api-test.tba.com/voucher/38911344/879010/1"/>
    </response>
</envelope>
```

Response fields:

- **booking@code**: our booking reference
- **status@code**: booking status as described in [integration guide](https://documentation.netstorming.net/integration-guide/booking-status)
- **deadline@date**: maximum allowed date for cancellation
- **start**:
- - **@date**: service date
- - **@time**: service time (optional)
- **language@code**: activity language (optional)
- **paxes**
- - **@number**: number of paxes
- - **pax**: data of traveller in the same format already used in this API
- **activity\_info** [See example](https://documentation.netstorming.net/examples/activity-info-example)
- **additional\_fields**:
- - **additional\_field**: additional field in the same format already used in this API
- **remarks** (optional): contains additional information about the service that should be shown to the customer. May contain useful info like inclusions/exclusions details, pickup/dropoff details and so on
- - **remark@text**: additional information about the service
- **prices**: total service prices
- - **nett**
- - - **@amount**: nett amount
- - - **@currency**: nett currency
- - **gross**
- - - **@amount**: gross amount (=nett amount + client markup)
- - - **@currency**: gross currency
- **voucher@url**: activity voucher (optional)

 [ ](https://documentation.netstorming.net/api-reference/activities/detailed-availability) [](https://documentation.netstorming.net/api-reference/activities/track)

---

## Navigation

- Parent: [Activities](https://documentation.netstorming.net/api-reference/activities.md)
- Previous: [Detailed availability](https://documentation.netstorming.net/api-reference/activities/detailed-availability.md)
- Next: [Track](https://documentation.netstorming.net/api-reference/activities/track.md)
