Import order and item statuses

Description

Imports an order, payment method and statuses of order items into the market.

Request URL

Method: POST

https://example.com/api/v1.1/market/orders/import

Request parameters

Parameter	Type	Example	Required	Description
custom_fields	array of objects	[    {       "external_id": "1234",       "name": "1234",       "entity_type": "line_order",       "required": false,       "value_type": "unicode",       "default_value": "data"    } ]	No	Create custom fields for the following entities: product SKU order order item Learn more
custom_line_statuses	array of objects	[    {       "external_id": "1234",       "name": "Arrived at the pickup point",       "type": "in_process"    } ]	No	Custom status of the order item. It is necessary to pass the status id (external_id), its name (name) and type (type). Possible values of the type field: delivered canceled refunded in_process Fields must be created before they can be used in an order.
skip_triggers	bool	true	No	Skip trigger events. By default – false
data	array of objects	[    {       "external_id": "123456",       "matching":"email",       "email":"example@example.com"       "endpoint": "endpoint_external_id",       "status": "new",       "total_price": "3000",       "currency": "USD",       "create_time": "2022-01-02T15:04:05.141Z",       "lines": [          {             "external_id": "7777",             "status": "new",             "product": "product_external_id",             "base_price_per_item": "600",             "min_price_per_item": "300",             "final_price_per_item": "500",             "count": 5          }       ]    } ]	Yes	Order data. In this block, you can specify values for previously created custom_fields

tip

If you need to set a value for an existing additional field, pass an object in custom_fields where the key is the external_id of that field, and the value is the required data

Request example

JSON

{
  "custom_fields": [
{
"external_id": "order_field_id_123",
"name": "Additional order field",
"entity_type": "order",
"required": false,
      "value_type": "unicode",
      "default_value": "value of the test field"
    },
    {
"external_id": "line_field_id_123",
"name": "Additional field of the order item",
"entity_type": "line_order",
"required": false,
      "value_type": "unicode",
      "default_value": "value of the test field"
    }
  ],
  "custom_line_statuses": [
{
"external_id": "status_id_123",
"name": "Delivered to pick-up point",
"type": "in_process"
    }
  ],
  "skip_triggers": true,
  "data": [
    {
      "external_id": "1234000",
      "matching": "email",
      "email": "johndoe@example.com",
      "endpoint": "website",
      "tags": ["one", "two"],
      "status": "delivered",
      "delivery_cost": "100",
      "total_price": "1000",
      "currency": "USD",
      "create_time": "2022-01-02T15:04:05.141Z",
      "custom_fields": {
        "order_field_id_123": "data"
      },
      "region": "region_YnCrJj8Y1",
      "lines": [
        {
          "external_id": "line_01",
          "status": "status_id_123",
          "product": "iphone_test_1",
          "base_price_per_item": "900",
          "min_price_per_item": "900",
          "final_price_per_item": "900",
          "count": 1,
          "custom_fields": {
            "line_field_id_123": "data"
          }
        }
      ]
    }
  ]
}

XML

<xml>
  <custom_fields>
    <external_id>order_field_id_123</external_id>
    <name>Additional order field</name>
    <entity_type>order</entity_type>
    <required>false</required>
    <value_type>unicode</value_type>
    <default_value>value of the test field</default_value>
  </custom_fields>
  <custom_fields>
    <external_id>line_field_id_123</external_id>
    <name>Additional field of the order item</name>
    <entity_type>line_order</entity_type>
    <required>false</required>
    <value_type>unicode</value_type>
    <default_value>value of the test field</default_value>
  </custom_fields>
  <custom_line_statuses>
    <external_id>status_id_123</external_id>
    <name>Delivered to the pick-up point</name>
    <type>in_process</type>
  </custom_line_statuses>
  <skip_triggers>true</skip_triggers>
  <data>
    <external_id>1234000</external_id>
    <matching>email</matching>
    <email>johndoe@example.com</email>
    <endpoint>website</endpoint>
    <tags>one</tags>
    <tags>two</tags>
    <status>delivered</status>
    <delivery_cost>100</delivery_cost>
    <total_price>1000</total_price>
    <currency>USD</currency>
    <create_time>2022-01-02T15:04:05.141Z</create_time>
    <custom_fields>
      <order_field_id_123>data</order_field_id_123>
    </custom_fields>
    <region>region_YnCrJj8Y1</region>
    <lines>
      <external_id>line_01</external_id>
      <status>status_id_123</status>
      <product>iphone_test_1</product>
      <base_price_per_item>900</base_price_per_item>
      <min_price_per_item>900</min_price_per_item>
      <final_price_per_item>900</final_price_per_item>
      <count>1</count>
      <custom_fields>
        <line_field_id_123>data</line_field_id_123>
      </custom_fields>
    </lines>
  </data>
</xml>

info

custom_fields at the root of the request creates new fields (an array), while in data it fills them with values (an object in the format "field_id": "value")

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
result	array	Product IDs that were successfully imported

Response example

JSON

{
  "error": 0,
  "error_text": "",
  "result": [
    {
      "error": 0,
      "external_id": "1234000"
    }
  ]
}

XML

<xml>
    <error>0</error>
    <error_text></error_text>
    <result>
        <error>0</error>
        <external_id>1234000</external_id>
    </result>
</xml>