---
updatedAt: 2026-09-17T14:12:52.000Z
agentTools:
  projectIndex: https://evy.readme.io/llms.txt
---

# The order object

## Example order object

```json Example B2C order object
{
  "object": "order",
  "id": "order-45",
  "evy_id": "ad970703-2625-4e81-8ba7-08e7f8afd127",
  "billing": {
    "city": "Paris",
    "country": "FR",
    "line1": "12 rue de la poste",
    "line2": null,
    "name": "Jane Doe",
    "phone": "+33712457843",
    "postal_code": "75002",
    "state": "Ile de France"
  },
  "created_at": "2022-03-01T17:28:33.689374Z",
  "currency": "EUR",
  "customer": {
    "external_id": "my-customer-12345",
    "city_of_birth": "Paris",
    "country_of_birth": "FR",
    "date_of_birth": "1985-01-05",
    "email": "janedoe@gmail.com",
    "first_name": "Jane",
    "fiscal_code": "XYZ123",
    "last_name": "Doe",
    "phone": "+33712457843"
  },
  "contract_registration_code": "registration-code-12345",
  "physical_store": {
    "id": "00001",
    "name": "Magasin Paris 00001"
  },
  "language": "fr-FR",
  "products": [
    {
      "id": "product-1-vaccum-cleaner",
      "title": "Dyson vacuum cleaner",
      "category_id": "1",
      "amount": 13999,
      "serial_number": "123456789",
      "condition": "refurbished",
      "refurbished_grade": "A",
      "purchased_at": "2022-03-01T17:28:33.689374Z",
      "purchase_date": "2022-03-01"
    },
    {
      "id": "product-2-phone",
      "title": "Phone model 10 Pro",
      "category_id": "2",
      "amount": 79999,
      "imei": "537937692990109",
      "condition": "new",
      "purchased_at": "2022-03-01T17:28:33.689374Z",
      "purchase_date": "2022-03-01"
    }
  ],
  "offer": {
    "id": "8455a9e1-2e0e-49be-b263-f4f4923e8f66",
    "amount": 1000,
    "purchased_at": "2022-03-01T17:28:33.689374Z"
  },
  "status": "paid",
  "seller": {
    "external_id": "a-seller-id",
    "display_name": "Seller name"
    },
  "store_id": "24ac248d-7e62-4c19-bb13-02845b2f38a8",
  "purchase_origin": "at_origin",
  "parent_contract_id": "8b37373a-2411-451b-82f3-c64c8ec77d62",
  "metadata": {
    "custom_field": "Example",
    "another_custom_field": [
      1,
      2
    ]
  }
}
```
```json Example B2B order object
{
  "object": "order",
  "id": "order-45",
  "evy_id": "ad970703-2625-4e81-8ba7-08e7f8afd127",
  "billing": {
    "city": "Paris",
    "country": "France",
    "line1": "12 rue de la poste",
    "line2": null,
    "name": "Jane Doe",
    "phone": "+33712457843",
    "postal_code": "75002",
    "state": "Ile de France"
  },
  "created_at": "2022-03-01T17:28:33.689374Z",
  "currency": "EUR",
  "customer": {
    "external_id": "my-customer-12345",
    "city_of_birth": "Paris",
    "country_of_birth": "France",
    "date_of_birth": "1985-01-05",
    "email": "janedoe@gmail.com",
    "first_name": "Jane",
    "fiscal_code": "XYZ123",
    "last_name": "Doe",
    "phone": "+33712457843"
  },
  "language": "fr-FR",
  "company": {
    "registration_number": "123456789"
  },
  "physical_store": {
    "id": "00001",
    "name": "Magasin Paris 00001"
  },
  "products": [
    {
      "id": "product-1",
      "title": "Dyson vacuum cleaner",
      "category_id": "1",
      "amount": 13999,
      "sku": "product-sku",
      "catalog_amount": 13999,
      "category": "Vaccul cleaners",
      "brand": "Dyson",
      "condition": "new",
      "description": "The new Dyson vacuum cleaner",
      "purchased_at": "2022-03-01T17:28:33.689374Z"
    },
  ],
  "offer": {
    "id": "8455a9e1-2e0e-49be-b263-f4f4923e8f66",
    "amount": 1000,
    "purchased_at": "2022-03-01T17:28:33.689374Z"
  },
  "intended_start_date": "2023-01-01",
  "status": "created",
  "seller": {
    "external_id": "a-seller-id",
    "display_name": "Seller name"
    },
  "store_id": "24ac248d-7e62-4c19-bb13-02845b2f38a8",
  "purchase_origin": "at_origin",
  "parent_contract_id": "8b37373a-2411-451b-82f3-c64c8ec77d62",
  "metadata": {
    "custom_field": "Example",
    "another_custom_field": [
      1,
      2
    ]
  }
}
```

## Attributes

<HTMLBlock>{`
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr>
  <th style="border: 1px solid #ddd; padding: 8px;"></th>
  <th style="border: 1px solid #ddd; padding: 8px;"></th>
  <th style="border: 1px solid #ddd; padding: 8px;"></th>
</tr>
</thead>
<tbody>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>Unique identifier for the order in your store such as a line item identifier. An identifier may only contain alphanumerics <code>0-9</code> <code>a-z</code> <code>A-Z</code> and unreserved characters <code>- </code> <code>.</code> <code>_</code> <code>~ </code>.  Any other special characters must be safely encoded.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>evy_id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>Unique identifier (UUID) generated by Evy of the order.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>object</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string, value is <code>order</code></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>String representing the object’s type. Objects of the same type share the same value.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>billing</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>address dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A nested object containing the customer&#39;s billing information for this order.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>created_at</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>timestamp</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>Time at which the object was created. Formatted as a <a href="https://datatracker.ietf.org/doc/html/rfc3339">RFC 3339</a> timestamp, with up to nanosecond precision.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>currency</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO 4217</a> currency code, in uppercase. Must be a <a href="ref:supported-currencies">supported currency</a>.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>language</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A valid BCP 47 language code that is used for communication regarding the order. Follows the same rules as the <a href="https://evy.readme.io/v1.2.0/reference/accept-language">Accept-Language header</a>.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>company</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>company dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A nested object containing the company information for this order in case of a B2B customer.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>physical_store</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>physical store dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A nested object containing the physical store information of the order if the order was placed from a physical store.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>customer</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A nested object containing the information of the customer for this order.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>group_id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>The string identifier of the group that this order belongs too. This is an optional field that is present when using the create grouped orders API.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>products</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>list</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A list of nested objects containing the information of the product purchased with offer.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>offer</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A nested object containing the information of the offer purchased.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>status</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>enum, possible values are <code>created</code>, <code>paid</code>,<code>cancelled</code>, <code>fulfilled</code>, <code>terminated</code></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>The status of the order.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>intended_start_date</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>timestamp</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>The starting date of the coverage of the insurance offer. Time at which the object was created. Formatted as a RFC 3339 timestamp, with up to nanosecond precision.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>store_id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>The unique identifier of the store this order belongs to.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>purchase_origin</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>enum</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><code>at_purchase</code> if the order was made at purchase time, <code>post_purchase</code> if made afterwards.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>seller</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>seller dictionary</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>As nested object containing seller information</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>metadata</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>any</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>User metadata for the order.<br>This is a free-form field that can be set to any JSON value, with a size limit of 1KB.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>subscription_id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>Unique identifier of the subscription linked to this order.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>contract_registration_code</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>A unique registration code provided by the merchant, enabling the customer to register their contract with Evy.</p>
</td>
</tr>
<tr>
  <td style="border: 1px solid #ddd; padding: 8px;"><p><strong>parent_contract_id</strong></p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>string</p>
</td>
  <td style="border: 1px solid #ddd; padding: 8px;"><p>The id of a parent contract to attach the order to, if the order being submitted is for an add-on contract.</p>
</td>
</tr>
</tbody>
</table>
`}</HTMLBlock>

## Address dictionary

|              |        |                                                                                                   |
| :----------- | :----- | :------------------------------------------------------------------------------------------------ |
| city         | string | City, district, suburb, town, or village.                                                         |
| country      | string | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). |
| line1        | string | Address line 1 (e.g., street, PO Box, or company name).                                           |
| line2        | string | Address line 2 (e.g., apartment, suite, unit, or building).                                       |
| name         | string | Recipient name.                                                                                   |
| phone        | string | Recipient phone (including extension).                                                            |
| postal\_code | string | Zip or postal code.                                                                               |
| state        | string | State, county, province, or region.                                                               |

## Company dictionary

|                          |                    |                                                                                                                                |
| :----------------------- | :----------------- | :----------------------------------------------------------------------------------------------------------------------------- |
| **registration\_number** | string             | The company's legal registration number (ie. SIREN in France). This will be present if this order is placed by a B2B customer. |
| **name**                 | string             | The company's name.                                                                                                            |
| **headquarters**         | address dictionary | A nested object containing the company's headquarters address.                                                                 |

## Customer dictionary

|                        |        |                                                                                                                                    |
| :--------------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------- |
| **city\_of\_birth**    | string | Customer's city of birth.                                                                                                          |
| **external\_id**       | string | Customer's ID as created and stored by the merchant. **This value must be unique.**                                                |
| **country\_of\_birth** | string | Customer's country of birth as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). |
| **date\_of\_birth**    | string | Customer's country of birth.                                                                                                       |
| **email**              | string | Customer's email.                                                                                                                  |
| **first\_name**        | string | Customer's first name.                                                                                                             |
| **fiscal\_code**       | string | Customer's fiscal code. Only relevant for Italian (*codice fiscale*) and Romanian (*Codul Numeric Personal*) customers.            |
| **last\_name**         | string | Customer's last name.                                                                                                              |
| **phone**              | string | Customer's phone (including extension).                                                                                            |

## Physical store dictionary

|          |        |                                 |
| :------- | :----- | :------------------------------ |
| **id**   | string | The ID of the physical store.   |
| **name** | string | The name of the physical store. |

## Product dictionary

|                        |           |                                                                                                                                                               |
| :--------------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **id**                 | string    | Unique identifier of the product purchased in your store.                                                                                                     |
| **title**              | string    | The title of the product.                                                                                                                                     |
| **category**           | string    | The category of the product.                                                                                                                                  |
| **category\_id**       | string    | The category ID of the product.                                                                                                                               |
| **description**        | string    | The description of the product.                                                                                                                               |
| **brand**              | string    | The brand of the product.                                                                                                                                     |
| **amount**             | integer   | Positive integer representing the purchase price in cents of the product in this order.                                                                       |
| **catalog\_amount**    | integer   | Positive integer representing the catalog price in cents of the product in this order.                                                                        |
| **condition**          | string    | The condition of the product.                                                                                                                                 |
| **refurbished\_grade** | string    | The refurbished grade of the product.                                                                                                                         |
| **sku**                | string    | The SKU of the product.                                                                                                                                       |
| **serial\_number**     | string    | The serial number of the product.                                                                                                                             |
| **imei**               | string    | The IMEI of the product.                                                                                                                                      |
| **purchased\_at**      | timestamp | Time at which the product was purchased. Formatted as a [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) timestamp, with up to nanosecond precision. |
| **purchase\_date**     | date      | Date at which the product was purchased. Formatted as a [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date (ex: `"2023-04-23"`).         |
| **model**              | string    | The model of the product.                                                                                                                                     |
| **color**              | string    | The color of the product.                                                                                                                                     |
| **storage**            | string    | The storage capacity of the product.                                                                                                                          |

## Offer dictionary

|                   |           |                                                                                                                                                             |
| :---------------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id**            | string    | Unique identifier (uuid) of the offer purchased in your store. Must be the identifier of the previously returned offer for this associated product.         |
| **amount**        | integer   | Positive integer representing the quoted price in cents of the offer purchased in this order.                                                               |
| **purchased\_at** | timestamp | Time at which the offer was purchased. Formatted as a [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) timestamp, with up to nanosecond precision. |

## Seller dictionary

|                   |        |                                   |
| :---------------- | :----- | :-------------------------------- |
| **external\_id**  | string | Identifier of the seller          |
| **display\_name** | string | Human readable name of the seller |