Order data format

Required columns:

  • id: Order ID in your CRM. Any value. Used to update the order statuses and re-match the order to other customers.
  • client_uniq_id: ID of the customer in your CRM linked to the order.
  • client_type: Type of customer with the client_uniq_id. Valid value: CONTACT.
  • create_date_time: Date and time of order creation in the tag's time zone. You can't change this value. Details.
  • order_status: Order status ID. An arbitrary string. You can change the status. Specify the value that you passed when mapping statuses in the id field.

Optional columns:

  • update_date_time: Date and time of order update in the tag's time zone. If the parameter is not passed, the value is inserted automatically. Details.

  • finish_date_time: Date and time of order completion in the tag's time zone. If you don't pass the value, it's automatically set to the date of the first transaction uploaded with the PAID group status. Details

  • 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: Cost price. A decimal number. You can pass the cost of orders so that the End-to-end analytics reports include data on your profits. The profit is calculated using the formula: Revenue - Cost.

    Note

    When a cost is specified, the revenue generated from completed goals within the order is calculated as revenue-cost.

  • products: Products in the order. Pass the product IDs and the number of items per order. The IDs will be available when creating a segment in Yandex Metrica if you don't pass product lists. If you create product lists, data from these lists, such as product names, will be available in Yandex Metrica.

  • goals: JS goals and their costs in the order. Pass the JS goal IDs and their costs (optional) in the order. For the JS goal IDs, use the corresponding conditions.url parameter values (example of creating a JS goal).

You can also transmit additional information about orders, such as the service type. To do this:

  1. Create an attribute that will match your additional parameter using the POST /cdp/api/v1/counter/{counterId}/schema/attributes method.
  2. Pass this attribute along with other order data using the POST /cdp/api/v1/counter/{counterId}/data/orders method (CSV or JSON). In JSON format, you can use the attribute_values array for convenience.

Learn more