Order and customer data format

Pass the fields below using the POST /cdp/api/v1/counter/{counterId}/data/simple_orders method.

Required columns:

  • create_date_time: Date and time of order creation in the tag's time zone. You can't change this value. Learn more
  • id: Order ID in your CRM. When updating an order, pass the same ID used when creating it.

At least one of the following columns is required:

  • client_ids: List of ClientIDs. To learn more, see Setting up delivery of detailed data about customers and orders from a CRM.
  • emails: List of the customer's email addresses. A string in Latin characters including the @ sign and a domain name. Don't use uppercase letters. Example: mail@yandex.ru.
  • phones: List of the customer's phone numbers. A numeric string containing a mobile phone number with a country code. You can't use spaces or extra characters. For example: 79995551111.
  • emails_md5: List of the customer's email addresses that are MD5 hashed.
  • phones_md5: List of the customer's phone numbers that are MD5 hashed.
Note. To pass one or more phone numbers or email addresses, enclose them in quotation marks. When passing multiple values, separate them with a comma.

Example: "79876543210,79991234567" or "mail@example.com,mail2@example.com".

Optional columns:

  • client_uniq_id: ID of the customer linked to the order in your CRM.
  • order_status: Order status type. An arbitrary string. You can change the status.

    Possible values:

    • PAID: Paid (default).
    • IN_PROGRESS: In progress.
    • CANCELED: Canceled.
    • SPAM: Spam.
  • revenue: Revenue. Total value of the order. A decimal number. Pass the revenue from the order. This value is used in End-to-end analytics reports to show how much money orders from advertising channels brought. You can see the value in the “Revenue” metric.
  • cost: Production cost. A decimal number. You can pass the production cost of orders so that the End-to-end analytics reports include data on your profits. The profit is calculated using the formula: