The order object

Example 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": "[email protected]",
    "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",
  "metadata": {
    "custom_field": "Example",
    "another_custom_field": [
      1,
      2
    ]
  }
}

{
  "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": "[email protected]",
    "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",
  "metadata": {
    "custom_field": "Example",
    "another_custom_field": [
      1,
      2
    ]
  }
}

Attributes


id	string	Unique identifier for the order in your store such as a line item identifier. An identifier may only contain alphanumerics `0-9` `a-z` `A-Z` and unreserved characters `-` `.` `_` `~` . Any other special characters must be safely encoded.
evy_id	string	Unique identifier (UUID) generated by Evy of the order.
object	string, value is `order`	String representing the object’s type. Objects of the same type share the same value.
billing	address dictionary	A nested object containing the customer's billing information for this order.
created_at	timestamp	Time at which the object was created. Formatted as a RFC 3339 timestamp, with up to nanosecond precision.
currency	string	Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.
language	string	A valid BCP 47 language code that is used for communication regarding the order. Follows the same rules as the Accept-Language header.
company	company dictionary	A nested object containing the company information for this order in case of a B2B customer.
physical_store	physical store dictionary	A nested object containing the physical store information of the order if the order was placed from a physical store.
customer	dictionary	A nested object containing the information of the customer for this order.
group_id	string	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.
products	list	A list of nested objects containing the information of the product purchased with offer.
offer	dictionary	A nested object containing the information of the offer purchased.
status	enum, possible values are `created`, `paid`,`cancelled`, `fulfilled`, `terminated`	The status of the order.
intended_start_date	timestamp	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.
store_id	string	The unique identifier of the store this order belongs to.
purchase_origin	enum	`at_purchase` if the order was made at purchase time, `post_purchase` if made afterwards.
seller	seller dictionary	As nested object containing seller information
metadata	any	User metadata for the order. This is a free-form field that can be set to any JSON value, with a size limit of 1KB.
subscription_id	string	Unique identifier of the subscription linked to this order.
contract_registration_code	string	A unique registration code provided by the merchant, enabling the customer to register their contract with Evy.

Address dictionary


city	string	City, district, suburb, town, or village.
country	string	Two-letter country code (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).
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 timestamp, with up to nanosecond precision.
purchase_date	date	Date at which the product was purchased. Formatted as a ISO 8601 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 timestamp, with up to nanosecond precision.

Seller dictionary


external_id	string	Identifier of the seller
display_name	string	Human readable name of the seller