NAV Navbar

Introduction

The document describes the methods of the Ozon Seller API. It will help you to manage products and orders. The document is intended for developers. Requests to the API are made via the HTTP protocol using POST or GET methods. Input and output data structures are passed in the request and response body. The API supports the JSON interoperability format.

The response contains the HTTP header with the request-response bundle ID (Trace-ID).

Authorization

HTTP Request example:

GET / HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: <Client-Id>
Api-Key: <Api-Key>
Content-Type: application/json

Every request must have an access token in its header:

  1. Log into your Ozon Seller account and go to Settings page.
  2. On the API keys tab generate an API key.

Sandbox

HTTP Request example:

GET / HTTP/1.1
Host: cb-api.ozonru.me
Client-Id: 836
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

The Sandbox simulates the API, but it is completely isolated from the real data. Here you can try to call API methods, receive responses, see changes in test data. Requests to the Sandbox do not change the data in Ozon Seller, created products and orders are not displayed anywhere.

Sandbox url: http://cb-api.ozonru.me.

Key Description
Client-Id 466
Api-Key 9753260e-2324-fde7-97f1-7848ed7ed097

Production environment

HTTP Request example:

GET / HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: {Your Client-Id}
Api-Key: {Your API Key}
Content-Type: application/json

Production environment affects real data. Every request changes data at Ozon Seller, created products and orders affects real user experience.

Production environment URL: https://api-seller.ozon.ru.

Created products can be viewed via the following link: https://www.ozon.ru/context/detail/id/SKU, where instead of "SKU" you need to specify a value for the required product. git

Products attributes and categories

Each product on Ozon is bound to a certain category and can have a set of attributes.
To add a product on our platform, it is necessary to associate categories of your platform with our categories.
Different categories have different set of attributes, as a rule these attributes are identical for categories of second level and lower.
A product can be added without attributes indication, however it reduces the likelihood that your product will be found by a customer. Attributes are used for search filters.

Categories and attributes can be changed. In that case you will get the notification with a list of modifications. These changes occur rarely, but it is important to keep it in mind.

Product categories

HTTP Request example:

POST /v1/category/tree HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "category_id": 17036076,
  "language": "EN"
}

Server Response example:

{
  "result": [
    {
      "category_id": 1,
      "title": "Books",
      "children": [
        {
          "category_id": 2,
          "title": "Glossary",
          "children": []
        },
        {
          "category_id": 3,
          "title": "Science Fiction",
          "children": []
        }
      ]
    }
  ]
}

translation missing: en.contact_us

Categories realization in the form of the tree.
The product adding is available only in categories of the lowest level, consequently you should associate these categories with categories of your platform.
Categories can not be created at user request.

Description of HTTP Request keys:

Key Type Required Description
category_id int No Category ID
language string No Language in which result will be returned. Possible values are: "EU" (Englush) and "RU" (Russian). By default, if key is not sent, Russian language is used

Description of Server Response keys:

Key Type Description
result array Category list
category_id int Category ID
title string Category title
children array Array of sub-categories

Attributes list

HTTP Request example:

POST /v1/category/attribute HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "attribute_type": "required",
  "category_id": 17036076,
  "language": "EN"
}

Server Response example:

{
  "result": [
    {
      "id": 1,
      "name": "Explosive",
      "description": "Mark for product if it is explosive",
      "type": "bool",
      "is_collection": false,
      "is_required": false,
      "option": [],
      "child": []
    },
    {
      "id": 2,
      "name": "Product name",
      "description": "Full product name",
      "type": "text",
      "is_collection": false,
      "is_required": true,
      "option": [],
      "child": []
    },
    {
      "id": 3,
      "name": "Size",
      "description": "List of possible sizes",
      "type": "text",
      "is_collection": true,
      "is_required": false,
      "option": [],
      "child": []
    },
    {
      "id": 4,
      "name": "Color",
      "description": "Main color",
      "type": "option",
      "is_collection": false,
      "is_required": false,
      "option": [
        {
          "id": 1,
          "value": "black"
        },
        {
          "id": 2,
          "value": "white"
        }
      ],
      "child": []
    },
    {
      "id": 5,
      "name": "Colors",
      "description": "List of possible colors",
      "type": "option",
      "is_collection": true,
      "is_required": false,
      "option": [
        {
          "id": 1,
          "value": "yellow"
        },
        {
          "id": 2,
          "value": "green"
        }
      ],
      "child": []
    },
    {
      "id": 6,
      "name": "Video",
      "description": "Main video",
      "type": "child",
      "is_collection": false,
      "is_required": false,
      "option": [],
      "child": [
        {
          "id": 10,
          "name": "Name",
          "description": "Name of video",
          "type": "text",
          "is_collection": false,
          "is_required": false,
          "option": []
        },
        {
          "id": 11,
          "name": "Url",
          "description": "Url to video",
          "type": "text",
          "is_collection": false,
          "is_required": false,
          "option": []
        }
      ]
    },
    {
      "id": 7,
      "name": "Videos",
      "description": "List of videos",
      "type": "child",
      "is_collection": true,
      "is_required": false,
      "option": [],
      "child": [
        {
          "id": 10,
          "name": "Name",
          "description": "Name of video",
          "type": "text",
          "is_collection": false,
          "is_required": false,
          "option": []
        },
        {
          "id": 11,
          "name": "Url",
          "description": "Url to video",
          "type": "text",
          "is_collection": false,
          "is_required": false,
          "option": []
        }
      ]
    }
  ]
}

Description of HTTP Request keys:

Key Type Required Description
category_id int Yes Category ID
attribute_type string No Filter attributes, possible values: "required", "optional"
language string No Language in which result will be returned. Possible values are: "EU" (Englush) and "RU" (Russian). By default, if key is not sent, Russian language is used

Description of Server Response keys:

Key Type Description
result array Category attributes list
id int Attribute ID
name string Product name. Up to 500 characters
description string Attribute description
type string Attribute type, possible values: bool, text, option, child
is_collection bool Attribute accepts multiple values
is_required bool Attribute is required
option array Array of predefined attribute values
option.id int Predefined attribute value ID
option.value string Predefined attribute value text
child array Array of child attributes, each child structure matches parent structure

Attribute list

HTTP Request example:

POST /v2/category/attribute HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "attribute_type": "required",
  "category_id": 17036076,
  "language": "EN"
}

Server Response example:

{
  "id": 1,
  "name": "Explosive",
  "description": "Mark for product if it is explosive", 
  "type": "bool",
  "is_collection": false,
  "is_required": false,
  "group_id": 0,
  "group_name": "", 
  "dictionary_id": 0 
}

translation missing: en.contact_us

Retrieve list off attributes for specified category.
Each attribute has a flag if it is required or not to be filled.
Attributes are divided into several types, the way of value filling depends on the attribute type.
There are attributes without significant value, e.g. gender can not be indicated for the hat: unisex, it is necessary to indicate two gender values: male, female.
There are system attributes, which are not visible for customers, forming products merging in one group. For example, "Model name" attribute in categories of "Clothes", "Shoes".

Description of HTTP Request keys:

Key Type Required Description
category_id int Yes Category ID
attribute_type string No Filter attributes, possible values: "required", "optional"
language string No Response language: EN or RU. Default set to RU.

Description of Server Response keys:

Key Type Description
id int Attribute ID
name string Product name. Up to 500 characters
description string Attribute description
type string Attribute type, possible values: bool, text, option, child
is_collection bool Attribute accepts multiple values
is_required bool Attribute is required
group_id int Attribute group id.
group_name string Attribute group name.
dictionary_id int Dictionary id.

Determine product category

HTTP Request example:

POST /v1/product/classify HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "products": [
    {
      "offer_id": "147190464",
      "shop_category_full_path": "Электроника/Телефоны и аксессуары/Смартфоны",
      "shop_category": "Смартфоны",
      "shop_category_id": 15502,
      "vendor": "Apple, Inc",
      "model": "iPhone XS 256GB Space Grey",
      "name": "Смартфон Apple iPhone XS 256GB Space Grey",
      "price": "100990",
      "offer_url": "https://www.ozon.ru/context/detail/id/147190464/",
      "img_url": "https://ozon-st.cdn.ngenix.net/multimedia/1024351473.jpg",
      "vendor_code": "apple_inc",
      "barcode": "190198794017"
    }
  ]
}

Server Response example:

{
  "result": [
    {
      "offer_id": "147190464",
      "category_id": 17039977,
      "classifier_status": "CLASSIFIED"
    }
  ]
}

Automatically determines a product category for a product on OZON, based on a set of inputs described below. Please note, that this tool is in testing and may not provide a 100% accuracy. It's currently available only for products with description in Russian and returns category_id for Production environment. Up to 100 items may be sent in one request

Description of HTTP Request keys:

Key Type Required Description
barcode string No Product barcode.
img_url string No Image link starting with http:// or https://. Up to 1000 characters, JPEG or PNG image formats
model string No Product model. For example, "iPhone XS 256 GB Space Grey" - is a product model, while, а "Apple, Inc" is a vendor
name string Yes Product name. Up to 500 characters
offer_id string Yes Product ID in Seller's ERP
offer_url string No Link to a product on Seller's website
price string No Price after discount
shop_category string No Category name in which a product is located within Seller's ERP or website
shop_category_full_path string No Full path to category in which a product is located within Seller's ERP or website
shop_category_id int No Category ID in which a product is located within Seller's ERP or website
vendor string No Manufacturer. Up to 100 characters
vendor_code string No Manufacturer code. Up to 100 characters

Description of Server Response keys:

Key Type Description
offer_id string Product ID in Seller's ERP
category_id int Category ID
status string Product classify result (CLASSIFIED/NOT_CLASSIFIED)

Check attribute ID

HTTP Request example:

POST /v2​/category​/attribute​/value​/by-option HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "options": [
     {
       "attribute_id": 8229,
       "option_id": 400
     }
  ],
  "language": "EN"
}

Server Response example:

{
  "result": [
    {
      "id": 91466,
      "option_id": 400,
      "attribute_id": 8229,
      "value": "Электрический насос" 
    }
  ]
}

If an attribute or option has changed its ID, you can check the new one by passing old ID to POST ​/v2​/category​/attribute​/value​/by-option.

Description of HTTP Request keys:

Key Type Required Description
options array No Array of options.
attribute_id int No Old attribute ID.
option_id int No Old option ID.
language string Yes Response language: EN or RU. Default set to RU.

Description of Server Response keys:

Key Type Description
id int New ID.
option_id int Old option ID.
attribute_id int Old attribute ID.
value string Attribute value.

Attributes dictionary

HTTP Request example:

POST /v2​/category​/attribute​/values HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "category_id": 17036076,
  "attribute_id": 8229,
  "language": "EN",
  "last_value_id": 0,
  "limit": 1
}

Server Response example:

{
  "result": [
    {
      "id": 115845746,
      "value": "President",
      "picture": "http://cdn1.ozone.ru/multimedia/1029443311.jpg",
      "info": "Продукты питания"
    }
  ]
}

Check the dictionary for attributes or options by theirs IDs.

Description of HTTP Request keys:

Key Type Required Description
category_id int Yes Category ID.
attribute_id int Yes Attribute ID.
last_value_id int No translation missing: en.in_last_value_id
limit int Yes Number of packages in response.
language string No Response language: EN or RU. Default set to RU.

Description of Server Response keys:

Key Type Description
id int Products attribute id.
value string Attribute value.
picture string Product image URL.
info string Information about products category.

Product Adding & Updating

Ozon offers a set of handlers for adding products. Upload products in bunches or add/update them one by one.
During trial integration, we recommend going with one-by-one adding as this approach ensures concurrent data validation.
Product adding is a multistage procedure which takes some time after you submit a request as we have to process all requests we receive. Processing also consists of several phases and any of them may lead to the error. Some errors regard input data validation or are discovered during product moderation. In such case, you will have to upload corrected product information.
The system sets the following product update restrictions:

Batch products import

HTTP Request example:

POST /v1/product/import HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "items": [{
    "barcode": "8801643566784",
    "description": "Red Samsung Galaxy S9 with 512GB",
    "category_id": 17030819,
    "name": "Samsung Galaxy S9",
    "offer_id": "REDSGS9-512",
    "price": "79990",
    "old_price": "89990",
    "premium_price": "75555",
    "vat": "0",
    "vendor": "Samsung",
    "vendor_code": "SM-G960UZPAXAA",
    "height": 77,
    "depth": 11,
    "width": 120,
    "dimension_unit": "mm",
    "weight": 120,
    "weight_unit": "g",
    "images": [
       {
         "file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555115.jpg",
         "default": true
       },
       {
         "file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555110.jpg",
         "default": false
       },
       {
         "file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555111.jpg",
         "default": false
       }
     ],
    "attributes": [
      {
        "id": 8229,
        "value": "4747"
      },
      {
        "id": 9048,
        "value": "Samsung Galaxy S9"
      },
      {
        "id": 4742,
        "value": "512 ГБ"
      },
      {
        "id": 4413,
        "collection": ["1", "2", "13"]
      },
      {
        "id": 4018,
        "complex_collection": [
          {
            "collection": [
              {
                "id": 4068,
                "value": "Additional video"
              },
              {
                "id": 4074,
                "value": "5_-NKRVn7IQ"
              }
            ]
          },
          {
            "collection": [
              {
                "id": 4068,
                "value": "Another one video"
              },
              {
                "id": 4074,
                "value": "5_-NKRVn7IQ"
              }
            ]
          }
        ]
      }
  ]
 }]
}

Server Response example:

{
  "result": {
    "task_id": 123
  }
}

This method allows to create or update up to 1000 products. Products update puts them to moderation queue, so this method should be used to update product description and attributes. Product prices should be updated using Price import

Description of HTTP Request keys:

Key Type Required Description
barcode string No Product barcode.
description string Yes Product description. Use br HTML tag for a line break переноса строки в описании необходимо использовать HTML-тег
category_id int Yes Category ID. During item creation, you should state a category that does not have any nested categories
name string Yes Product name. Up to 500 characters
offer_id string Yes Product ID in Seller's ERP
price string Yes Price after discount
old_price string No Price before discount
premium_price string No Price for premium subscription
vat string Yes Tax rate, possible values: 0, 0.1, 0.2
vendor string No Manufacturer. Up to 100 characters
vendor_code string No Manufacturer code. Up to 100 characters
attributes array Yes Product attributes array
attributes.id int Yes Attribute ID
attributes.value string No Attribute value
attributes.collection array No Array of attribute values. For example, attribute Color may include both Black and White
attributes.complex array No Array of attributes that support inserted attributes. For example, CPU is an attribute, that has different inserted attributes (Manufacturer, CPU Speed, CPU Cache, etc)
attributes.complex_collection array No Array of attributes that have several attributes with the same title, but with different values. For example, an Audiobook on a CD has several Audio track attributes. Each audio track has its own Audio length, Bitrate, etc.
attributes.complex_collection. collection array No Array of complex attributes with multiple choice values
images array Yes Array of images, up to 10 images
images.file_name string Yes Image link starting with http:// or https://. Up to 1000 characters, JPEG or PNG image formats
images.default bool Yes Marks image as default
height int Yes Package height. Maximum value is 10 meters (optional for Crossborder)
depth int Yes Package depth. Maximum value is 10 meters (optional for Crossborder)
width int Yes Package width. Maximum value is 10 meters (optional for Crossborder)
dimension_unit string Yes Dimension units. Available values: mm (millimeters), cm (centimetres), in (inches)
weight int Yes Package weight. Maximum value is 1000 kilograms (or converted value in another weight units)
weight_unit string Yes Weight unit. possible values: g (grams), kg (kilograms), lb (pounds)

Description of Server Response keys:

Key Type Description
result array List of order IDs
task_id int Product import task id. You can retreive its status using Product creation status handle

In order to create an item with different colors/sizes, you need to fill in attribute 8292 (Название модели - Model name). Items with same model of different sizes and colors, should have the same value (string) of 8292 attribute.

For example you have one product with 2 colors (black, white) and 3 sizes (40, 42, 43). All of these products should have same value (string) of 8292 attribute.

Color Size "Model name" (8292) attribute value
Black 40 SAME_MODEL_NAME
Black 42 SAME_MODEL_NAME
Black 43 SAME_MODEL_NAME
White 40 SAME_MODEL_NAME
White 42 SAME_MODEL_NAME
White 43 SAME_MODEL_NAME

All products with same 8292 attribute will be gathered into one item card.

Product creation status

HTTP Request example:

POST /v1/product/import/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "task_id": 33919
}

Server Response example:

{
  "result": {
    "items": [
      {
        "offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23",
        "product_id": 5376526,
        "status": "processed"
      }
    ],
    "total": 1
  }
}

Retreives product creation status.

Description of HTTP Request keys:

Key Type Required Description
task_id int Yes Product import task id

Description of Server Response keys:

Key Type Description
result array List of order IDs
items array Order items array
items.offer_id string Product ID in Seller's ERP
items.product_id int Item ID.
items.status string Item creation state. Item is created in queues. Possible values are: processing, moderating, processed, failed_moderation, failed_validation, failed. You can check final status of item info update using Product info method

translation missing: en.prepayment_set

HTTP Request example:

POST /v1/product/prepayment/set HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "is_prepayment": true,
  "offers_ids": [
    "Offer_RbtbQseqtTeBlHB8AjF9t-23"
  ],
  "products_ids": [
    5376526
  ]
}

Server Response example:

{
  "result": {
    "item_updated": [
      {
        "success": true,
        "product_id": 0,
        "offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23"
      },
      {
        "success": false,
        "product_id": 5376526,
        "offer_id": ""
      }
    ]
  }
}

translation missing: en.prepayment_set_desc

Description of HTTP Request keys:

Key Type Required Description
is_prepayment boolean Yes translation missing: en.in_is_prepayment
offers_ids array No translation missing: en.in_offers_ids
products_ids array No translation missing: en.in_products_ids

Description of Server Response keys:

Key Type Description
item_updated array Updated items info.
item_updated.offer_id string Products id in sellers system.
item_updated.product_id int Product id.
item_updated.success boolean Query result:
  • true — changes applied;
  • false — an error ocurred.

v2: Batch products import

HTTP Request example:

POST /v2/product/import HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "items": [
    {
      "attributes": [
        {
          "complex_id": 0,
          "id": 0,
          "values": [
            {
              "dictionary_value_id": 0,
              "value": "string"
            }
          ]
        }
      ],
      "barcode": "string",
      "category_id": 0,
      "complex_attributes": [
        {
          "attributes": [
            {
              "complex_id": 0,
              "id": 0,
              "values": [
                {
                  "dictionary_value_id": 0,
                  "value": "string"
                }
              ]
            }
          ]
        }
      ],
      "depth": 0,
      "dimension_unit": "string",
      "height": 0,
      "image_group_id": "string",
      "images": [
        "string"
      ],
      "images360": [
        "string"
      ],
      "name": "string",
      "offer_id": "string",
      "old_price": "string",
      "pdf_list": [
        {
          "index": 0,
          "name": "string",
          "src_url": "string"
        }
      ],
      "premium_price": "string",
      "price": "string",
      "vat": "string",
      "weight": 0,
      "weight_unit": "string",
      "width": 0
    }
  ]
}

Server Response example:

{
  "result": {
    "task_id": 123
  }
}

Up to 1000 products per request.

Description of HTTP Request keys:

Key Type Required Description
items string Yes translation missing: en.in_items2
attributes array Yes Product attributes array
complex_id int No Dictionary ID.
id int Yes Attribute ID
values array No Array of nested attributes.
dictionary_value_id int No translation missing: en.in_dictionary_value_id
value string No translation missing: en.in_value
barcode string No Product barcode.
category_id int Yes Category ID. During item creation, you should state a category that does not have any nested categories
complex_attributes array No translation missing: en.in_complex_attributes
depth int Yes Package depth. Maximum value is 10 meters (optional for Crossborder)
dimension_unit string Yes Dimension units. Available values: mm (millimeters), cm (centimetres), in (inches)
height int Yes Package height. Maximum value is 10 meters (optional for Crossborder)
image_group_id string No translation missing: en.in_image_group_id
images array Yes Array of images, up to 10 images
images360 array No translation missing: en.in_images360
file_name string Yes translation missing: en.in_file_name
offer_id int Yes Product ID in Seller's ERP
old_price string No Price before discount
pdf_list array No translation missing: en.in_pdf_list
index int No
src_url string No translation missing: en.in_src_url
premium_price string No Price for premium subscription
price string Yes Price after discount
vat string Yes Tax rate, possible values: 0, 0.1, 0.2
weight int Yes Package weight. Maximum value is 1000 kilograms (or converted value in another weight units)
weight_unit string Yes Weight unit. possible values: g (grams), kg (kilograms), lb (pounds)
width int Yes Package width. Maximum value is 10 meters (optional for Crossborder)

Description of Server Response keys:

Key Type Description
result2 array translation missing: en.out_result_array2
task_id int Product import task id. You can retreive its status using Product creation status handle

Product creation status

HTTP Request example:

POST /v1/product/import/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "task_id": 33919
}

Server Response example:

{
  "result": {
    "items": [
      {
        "offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23",
        "product_id": 5376526,
        "status": "processed"
      }
    ],
    "total": 1
  }
}

Retreives product creation status.

Description of HTTP Request keys:

Key Type Required Description
task_id int Yes Product import task id

Description of Server Response keys:

Key Type Description
result array List of order IDs
items array Order items array
items.offer_id string Product ID in Seller's ERP
items.product_id int Item ID.
items.status string Item creation state. Item is created in queues. Possible values are: processing, moderating, processed, failed_moderation, failed_validation, failed. You can check final status of item info update using Product info method

translation missing: en.prepayment_set

HTTP Request example:

POST /v1/product/prepayment/set HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "is_prepayment": true,
  "offers_ids": [
    "Offer_RbtbQseqtTeBlHB8AjF9t-23"
  ],
  "products_ids": [
    5376526
  ]
}

Server Response example:

{
  "result": {
    "item_updated": [
      {
        "success": true,
        "product_id": 0,
        "offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23"
      },
      {
        "success": false,
        "product_id": 5376526,
        "offer_id": ""
      }
    ]
  }
}

translation missing: en.prepayment_set_desc

Description of HTTP Request keys:

Key Type Required Description
is_prepayment boolean Yes translation missing: en.in_is_prepayment
offers_ids array No translation missing: en.in_offers_ids
products_ids array No translation missing: en.in_products_ids

Description of Server Response keys:

Key Type Description
item_updated array Updated items info.
item_updated.offer_id string Products id in sellers system.
item_updated.product_id int Product id.
item_updated.success boolean Query result:
  • true — changes applied;
  • false — an error ocurred.

Product info

HTTP Request example:

POST /v1/product/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "offer_id": "item_6060091",
  "product_id": 7154396,
  "sku": 150583609
}

Server Response example:

{
  "result": {
    "barcode": "",
    "buybox_price": "",
    "category_id": 17034461,
    "created_at": "2019-11-26T10:40:44.940Z",
    "id": 7154396,
    "images": [
      "https://cdn1.ozone.ru/multimedia/1028110514.jpg"
    ],
    "marketing_price": "",
    "min_ozon_price": "3599.0000",
    "name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
    "offer_id": "item_6060091",
    "old_price": "",
    "premium_price": "",
    "price": "3599.0000",
    "recommended_price": " ",
    "sku": 150583609,
    "sources": [
      {
        "is_enabled": true,
        "sku": 150583609,
        "source": "fbo"
      }
    ],
    "state": "processed",
    "stock": 120,
    "stocks": {
      "coming": 0,
      "present": 120,
      "reserved": 0
    },
    "validation_errors": [],
    "vat": "0.2",
    "visibility_details": {
      "has_price": true,
      "has_stock": true,
      "active_product": true
    },
    "visible": true
  }
}

Receive product info.

Description of HTTP Request keys:

Key Type Required Description
product_id int No Item ID.
sku int No Unique product Ozon ID
offer_id string No Product ID in Seller's ERP

Description of Server Response keys:

Key Type Description
barcode string Product barcode.
buybox_price string Price for the main offer at Ozon.
category_id int Products category id.
created_at string Date and time of product creation.
id int Products attribute id.
images array Array of images
marketing_price string Products price including all discounts.
min_ozon_price sting Minimal price at Ozon Marketplace for this product.
name string Products name. Up to 500 symbols.
offer_id string Products id in sellers system.
old_price string Price before discounts. This price will be shown as crossed out.
premium_price string Price for premium subscription
price string Final product price including discounts, that will be shown to buyers.
recommended_price string Recommended price
sku int Unique product Ozon ID
sources array SKU list
sources.is_enabled bool SKU visibility
sources.sku int Product SKU
sources.source string SKU type: fbo/fbs/crossborder
state string Current product status in the system:
  • processing — request in progress; информация о товара добавляется в систему, ожидайте;
  • moderating
  • processed — product was added;
  • failed_moderation
  • failed_validation
  • failed
stock int Number of products in stock
stocks object Products stocks info
stocks.coming int Amount of coming products to warehouse
stocks.present int Amount of available products
stocks.reserved int Amount of reserved products
validation_errors array Array with validation errors info
validation_errors.code string Validation error code
validation_errors.error string Validation error description
validation_errors.field string Field in which an error occurred
vat string Tax rate, possible values: 0, 0.1, 0.2
visible bool Visibility of the product on Ozon
visibility_details object Array with visibility details. If any key is false, the product is not visible on OZON
visibility_details.active_product bool Product activation
visibility_details.has_price bool Product price
visibility_details.has_stock bool Product in stock

Product info v2

HTTP Request example:

POST /v2/product/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "offer_id": "item_6060091",
  "product_id": 7154396,
  "sku": 150583609
}

Server Response example:

{
  "barcode": "",
  "buybox_price": "",
  "category_id": 17034461,
  "created_at": "2019-11-26T10:40:44.940Z",
  "errors": [
    {
      "field": "string",
      "attribute_id": 0,
      "code": "string",
      "level": "string"
    }
  ],
  "id": 7154396,
  "images": [
    "https://cdn1.ozone.ru/multimedia/1028110514.jpg"
  ],
  "marketing_price": "",
  "min_ozon_price": "3599.0000",
  "name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
  "offer_id": "item_6060091",
  "old_price": "",
  "premium_price": "",
  "price": "3599.0000",
  "recommended_price": " ",
  "sources": [
    {
      "is_enabled": true,
      "sku": 150583609,
      "source": "fbo"
    }
  ],
  "state": "processed",
  "stocks": {
    "coming": 0,
    "present": 120,
    "reserved": 0
  },
  "vat": "0.2",
  "visibility_details": {
    "active_product": true,
    "has_price": true,
    "has_stock": true
  },
  "visible": true
}

Returns product info by its id.

translation missing: en.title_products_info_list

translation missing: en.desc_products_info_list

Description of HTTP Request keys:

Key Type Required Description
offer_id string No Product id in the sellers system.
product_id int No Product ID.
sku int No Product id, provided by Ozon.

HTTP Request example:

POST /v2/product/info/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "offer_id": [
    "item_6060091"
  ],
  "product_id": [],
  "sku": []
}

Server Response example:


{
  "result": {
    "items": [
      {
        "barcode": "",
        "buybox_price": "",
        "category_id": 17034461,
        "created_at": "2019-11-26T10:40:44.940Z",
        "errors": [
          {
            "attribute_id": 0,
            "code": "string",
            "field": "string",
            "level": "string"
          }
        ],
        "id": 7154396,
        "images": [
          "https://cdn1.ozone.ru/multimedia/1028110514.jpg"
        ],
        "marketing_price": "",
        "min_ozon_price": "3599.0000",
        "name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
        "offer_id": "item_6060091",
        "old_price": "",
        "premium_price": "",
        "price": "3599.0000",
        "price_index": "",
        "recommended_price": "",
        "sources": [
          {
            "is_enabled": true,
            "sku": 150583609,
            "source": "fbo"
          }
        ],
        "state": "processed",
        "stocks": {
          "coming": 0,
          "present": 120,
          "reserved": 0
        },
        "vat": "0.2",
        "visibility_details": {
          "active_product": true,
          "has_price": true,
          "has_stock": true
        },
        "visible": true
      }
    ]
  }
}

Description of Server Response keys:

Key Type Description
barcode string Product barcode.
buybox_price string Price for the main offer at Ozon.
category_id int Products category id.
created_at string Date and time of product creation.
errors array Validation errors info.
errors.attribute_id int
errors.code string Error code.
errors.field string Field with mistakes.
errors.level string
id int Products attribute id.
images array Array of images
marketing_price string Products price including all discounts.
min_ozon_price sting Minimal price at Ozon Marketplace for this product.
name string Products name. Up to 500 symbols.
offer_id string Products id in sellers system.
old_price string Price before discounts. This price will be shown as crossed out.
premium_price string Price for premium subscription
price string Final product price including discounts, that will be shown to buyers.
price_index string translation missing: en.out_price_index
recommended_price string Recommended price
sources array SKU list
sources.is_enabled bool SKU visibility
sources.sku int Product SKU
sources.source string SKU type: fbo/fbs/crossborder
state string Current product status in the system:
  • processing — request in progress; информация о товара добавляется в систему, ожидайте;
  • moderating
  • processed — product was added;
  • failed_moderation
  • failed_validation
  • failed
stocks object Products stocks info
stocks.coming int Amount of coming products to warehouse
stocks.present int Amount of available products
stocks.reserved int Amount of reserved products
vat string Tax rate, possible values: 0, 0.1, 0.2
visibility_details object Array with visibility details. If any key is false, the product is not visible on OZON
visibility_details.active_product bool Product activation
visibility_details.has_price bool Product price
visibility_details.has_stock bool Product in stock
visible bool Visibility of the product on Ozon

Product attributes

HTTP Request example:

POST /v2/products/info/attributes HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "filter": {
    "offer_id": [
      "ABC-123"
    ],
    "product_id": [
      2346321
    ]
  },
  "page": 0,
  "page_size": 0 
}

Server Response example:

{
  "result": [
    {
      "id": 0, 
      "offer_id": "ABC-123",
      "attributes": [
        {
          "attributeId": 8229,
          "values": [
            {
              "dictionaryValueId": 93055,
              "value": "Брюки"
            }
          ]
        }
      ],
      "barcode": "9785768404994",
      "category_id": 17027818,
      "complex_attributes": [
        {
          "attributes": [
            {
              "attributeId": 4074,
              "complexId": 4018,
              "values": [
                {
                  "dictionaryValueId": 0,
                  "value": "nN4OHnjB0nU"
                }
              ]
            }
          ]
        }
      ],
      "depth": 10,
      "dimension_unit": "mm",
      "height": 10,
      "image_group_id": "ABC-123",
      "images": [
        {
          "file_name": "https://cdn1.ozone.ru/s3/multimedia-a/1022555115.jpg",
          "default": true,
          "index": 0
        }
      ],
      "images360": [
        {
          "file_name": "https://cdn1.ozone.ru/s3/multimedia-a/1022555115.jpg",
          "index": 0
        }
      ],
      "name": "Набор 5 ламп ST64 LED 4W Диммируемые",
      "pdf_list": [
        {
          "file_name": "https://cdn1.ozone.ru/s3/pdf/1022555116.pdf",
          "index": 0,
          "name": "Инструкция"
        }
      ],
      "weight": 10,
      "weight_unit": "g",
      "width": 10
    }
  ]
}

Retrieve list off attributes for specified product.

Description of HTTP Request keys:

Key Type Required Description
filter Yes translation missing: en.in_filter2
offer_id string No Product id in the sellers system.
product_id int No Product ID.
page int No Page number in response.
page_size int No Amount of attributes on the page.

Description of Server Response keys:

Key Type Description
attributes array Array of attributes.
attributeId int Attribute id.
complexId int Id of attributes array that support inserted attributes. For example, CPU is an attribute, that has different inserted attributes (Manufacturer, CPU Speed, CPU Cache, etc)
values array Array of attribute values.
dictionaryValueId int Id of value in the dictionary.
value string Attribute value.
barcode string Product barcode.
category_id int Products category id.
complex_attributes array Array of complex attributes.
depth int Depth.
dimension_unit string Dimension unit.
height int Height.
id int Products attribute id.
image_group_id string Image group id.
images array Array of images
default boolean true, if it is main image.
file_name string Image URL. Up to 1000 symbols, JPEG or PNG format.
index int
images360 array Array of 360-images.
name string Products name. Up to 500 symbols.
offer_id string Products id in sellers system.
pdf_list array Array of pdfs.
weight int Weight.
weight_unit string Weight unit.
width int Width.

Products stocks info

HTTP Request example:

POST /v1/product/info/stocks HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "page": 1,
  "page_size": 100
}

Server Response example:

{
  "result": {
    "items":[
      {
        "product_id": 123,
        "offer_id": "SAMSGGLXS10",
        "stock": {
          "coming": 0,
          "present": 12,
          "reserved": 0
        }
      },
      {
        "product_id": 345,
        "offer_id": "SAMSGGLXS30",
        "stock": {
          "coming": 0,
          "present": 24,
          "reserved": 2
        }
      }
    ]
  }
}

Receive products stocks info

Description of HTTP Request keys:

Key Type Required Description
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 20, maximum is 1000 products on the page

Description of Server Response keys:

Key Type Description
items array Products stocks info
product_id int Item ID.
offer_id string Product ID in Seller's ERP
stock array Number of products in stock
stock.coming int Amount of coming products to warehouse
stock.present int Amount of available products
stock.reserved int Amount of reserved products

Products prices info

HTTP Request example:

POST /v1/product/info/prices HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "page": 1,
  "page_size": 100
}

Server Response example:

{
  "result": {
    "items": [
      {
        "product_id": 253611,
        "offer_id": "УТ-00007992",
        "price": {
          "price": "2489.0000",
          "old_price": "2489.0000",
          "premium_price": "",
          "recommended_price": "",
          "retail_price": "",
          "vat": "0.000000",
          "buybox_price": "",
          "min_ozon_price": "2489.0000",
          "marketing_price": "2489.0000"
        }
      }
    ],
    "total": 5594
  }
}

Receive products prices info

Description of HTTP Request keys:

Key Type Required Description
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 20, maximum is 1000 products on the page

Description of Server Response keys:

Key Type Description
items array Products info.
product_id int Product id.
offer_id string Products id in sellers system.
price object Final product price including discounts, that will be shown to buyers.
price.price string Final product price including discounts, that will be shown to buyers.
price.old_price string Price before discounts. This price will be shown as crossed out.
price.premium_price string Price for customers with Ozon Premium subsctiption.
price.recommended_price string Recommended price, based on similar offers.
price.retail_price string Price on product for retail.
price.vat string Tax rate, possible values: 0, 0.1, 0.2
price.buybox_price string Price for the main offer at Ozon.
price.min_ozon_price sting Minimal price at Ozon Marketplace for this product.
price.marketing_price string Products price including all discounts.
price_index string translation missing: en.out_price_index

Products list

HTTP Request example:

POST /v1/product/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "filter": {
    "offer_id": [
      "1255959"
    ],
    "product_id": [
      552526
    ],
    "visibility": "ALL"
  },
  "page": 1,
  "page_size": 100
}

Server Response example:

{
  "result": {
    "items": [
      {
        "product_id": 124100,
        "offer_id": "REDSGS10-128"
      },
      {
        "product_id": 124201,
        "offer_id": "REDSGS10-512"
      }
    ],
    "total": 4
  }
}

Receive the list of products.

Description of HTTP Request keys:

Key Type Required Description
filter array No Array with additional filters
filter.offer_id string array No Filter by offer_id. Supports multiple values
filter.product_id int array No Filter by product_id. Supports multiple values
filter.visibility string No Product visibility filter, possible values:
  • ALL: all products
  • VISIBLE: products, visible for customers
  • INVISIBLE: products, invisible for customers for some reason
  • EMPTY_STOCK: products with empty stock
  • READY_TO_SUPPLY: products with empty stock and state=processed (so you can set stock)
  • STATE_FAILED: products which are failed on some step
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 20, maximum is 1000 products on the page

Description of Server Response keys:

Key Type Description
result array List of order IDs
product_id int Item ID.
offer_id string Product ID in Seller's ERP

Update price

HTTP Request example:

POST /v1/product/import/prices HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "prices": [
    {
      "product_id": 120000,
      "offer_id": "PRD-1",
      "price": "79990",
      "old_price": "89990",
      "premium_price": "75555"
    },
    {
      "product_id": 124100,
      "offer_id": "PRD-2",
      "price": "79990",
      "old_price": "89990",
      "premium_price": "75555",
    },
    {
      "product_id": 124201,
      "offer_id": "PRD-3",
      "price": "89990",
      "old_price": "79990",
      "premium_price": "75555",
    }
  ]
}

Server Response example:

{
  "result": [
    {
      "product_id": 120000,
      "offer_id": "PRD-1",
      "updated": false,
      "errors": [
        {"code": "not_found", "message": "Product not found"}
      ]
    },
    {
      "product_id": 124100,
      "offer_id": "PRD-2",
      "updated": true,
      "errors": []
    },
    {
      "product_id": 124201,
      "offer_id": "PRD-3",
      "updated": true,
      "errors": []
    }
  ]
}

Update the price for one or multiple products. It is possible to update up to 1000 products prices

Description of HTTP Request keys:

Key Type Required Description
product_id int No Item ID.
offer_id string Yes Product ID in Seller's ERP
price string Yes Price after discount
old_price string No Price before discount
premium_price string No Price for premium subscription

Description of Server Response keys:

Key Type Description
result array List of order IDs
product_id int Item ID.
offer_id string Product ID in Seller's ERP
updated bool Update success/fail

Update stocks

HTTP Request example:

POST /v1/product/import/stocks HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "stocks": [
    {
      "product_id": 120000,
      "offer_id": "PRD-1",
      "stock": 20
    },
    {
      "product_id": 124100,
      "offer_id": "PRD-2",
      "stock": 20
    }
  ]
}

Server Response example:

{
  "result": [
    {
      "product_id": 120000,
      "offer_id": "PRD-1",
      "updated": false,
      "errors": [
        {"code": "offer_id_not_found", "message": "Product not found"}
      ]
    },
    {
      "product_id": 124100,
      "offer_id": "PRD-2",
      "updated": true,
      "errors": []
    }
  ]
}

Update product stocks. It is possible to update up to 100 products stocks

Description of HTTP Request keys:

Key Type Required Description
product_id int No Item ID.
offer_id string Yes Product ID in Seller's ERP
stock int Yes Number of products in stock

Description of Server Response keys:

Key Type Description
result array List of order IDs
product_id int Item ID.
offer_id string Product ID in Seller's ERP
updated bool Update success/fail
errors array Errors information
errors.code string Error code
  • OVER_MAX_OVH_KGT: The weight or dimensions of your product exceed the allowed maximum. You cannot update stock. More info
  • OVER_MAX_OVH_NON_KGT: You cannot sell oversized products from this warehouse. More info
  • NON_KGT_ON_KGT_WAREHOUSE: ВYou are trying to sell an ordinary product as oversized. It will be sold to customers under same conditions as other oversized products. More info
  • STOCK_TOO_BIG: Stock value is too big, please, reduce it
  • INVALID_STATE: Product has not passed all creation steps, please, check product state
  • CANNOT_CREATE_FBS_SKU: A problem occurred, please try again
  • NOT_FOUND: Product with this offer_id not found
errors.message string Error message

Update product info

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "barcode": "8801643566784",
  "description": "Red Samsung Galaxy S10 with 512GB",
  "name": "Samsung Galaxy S10",
  "vendor": "Samsung",
  "vendor_code": "SM-G960UZPAXAA",
  "height": 77,
  "depth": 11,
  "width": 120,
  "dimension_unit": "mm",
  "weight": 120,
  "weight_unit": "g",
  "images": [
    {
      "file_name": "http://pic.com/1.jpg",
      "default": true
    },
    {
      "file_name": "http://pic.com/2.jpg",
      "default": false
    },
    {
      "file_name": "http://pic.com/3.jpg",
      "default": false
    }
  ],
  "attributes": [
    {
      "id": 1,
      "value": "Samsung Galaxy S10"
    },
    {
      "id": 2,
      "collection": [
        "128GB",
        "512GB"
      ]
    },
    {
      "id": 3,
      "complex": [
        {
          "id": 10,
          "value": "Unboxing video"
        },
        {
          "id": 11,
          "value": "http://videos.com/1.mp4"
        }
      ]
    },
    {
      "id": 4,
      "complex_collection": [
        {
          "collection": [
            {
              "id": 10,
              "value": "Additional video"
            },
            {
              "id": 11,
              "value": "http://videos.com/2.mp4"
            }
          ]
        },
        {
          "collection": [
            {
              "id": 10,
              "value": "Another one video"
            },
            {
              "id": 11,
              "value": "http://videos.com/3.mp4"
            }
          ]
        }
      ]
    }
  ]
}

Server Response example:

{
  "result": {
    "updated": true
  }
}

Change the product info. Please note, that you cannot update price and stocks. Use Update price and Update stocks methods for this

Description of HTTP Request keys:

Key Type Required Description
product_id int Yes Item ID.
barcode string No Product barcode.
description string No Product description. Use br HTML tag for a line break переноса строки в описании необходимо использовать HTML-тег
name string No Product name. Up to 500 characters
vendor string No Manufacturer. Up to 100 characters
vendor_code string No Manufacturer code. Up to 100 characters
attributes array No Product attributes array
attributes.id int No Attribute ID
attributes.value string No Array of attribute values. For example, attribute Color may include both Black and White
attributes.collection array No Array of attribute values. For example, attribute Color may include both Black and White
attributes.complex array No Array of attributes that support inserted attributes. For example, CPU is an attribute, that has different inserted attributes (Manufacturer, CPU Speed, CPU Cache, etc)
attributes.complex_collection array No Array of attributes that have several attributes with the same title, but with different values. For example, an Audiobook on a CD has several Audio track attributes. Each audio track has its own Audio length, Bitrate, etc.
attributes.complex_collection. collection array No Array of complex attributes with multiple choice values
images array No Array of images, up to 10 images
images.file_name string No Image link starting with http:// or https://. Up to 1000 characters, JPEG or PNG image formats
images.default bool No Marks image as default
height int No Package height. Maximum value is 10 meters (optional for Crossborder)
depth int No Package depth. Maximum value is 10 meters (optional for Crossborder)
width int No Package width. Maximum value is 10 meters (optional for Crossborder)
dimension_unit string No Dimension units. Available values: mm (millimeters), cm (centimetres), in (inches)
weight int No Package weight. Maximum value is 1000 kilograms (or converted value in another weight units)
weight_unit string No Weight unit. possible values: g (grams), kg (kilograms), lb (pounds)

Description of Server Response keys:

Key Type Description
result array List of order IDs
updated bool Update success/fail

Product attributes examples

For every product in Ozon there is a product page — it is the page with the main product information and attributes. The set of attributes can be different and depends on the product category. You can get a set of attributes using the method Attributes list. The resulting attribute values should be transferred when creating or updating information in the product page (methods Create product page and Update product page).

Boolean attribute (type=bool)

Possible values for this attribute are: "true", "false"

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4652,
      "value": "true"
    }
  ]
}

Attribute values example:

Key Value
id 4652
name Признак 18+
description -
is_collection false
is_required false
type bool
option -
child -

Text attribute (type=text and is_collection=false)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 9164,
      "value": "Return possible only during 7 days"
    }
  ]
}

Attribute values example:

Key Value
id 9164
name Условия возврата
description -
is_collection false
is_required false
type text
option -
child -

Array of text attributes (type=text and is_collection=true)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4057,
      "collection": [
        "10",
        "20"
      ]
    }
  ]
}

Attribute values example:

Key Value
id 4057
name Страницы
description -
is_collection true
is_required false
type text
option -
child -

Fixed value attribute (type=option and is_collection=false)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4061,
      "value": "14"
    }
  ]
}

Attribute values example:

Key Value
id 4061
name Техника изображения
description -
is_collection false
is_required false
type option
option
option.id 5
option.value Акварель
option.id 14
option.value Акватинта
child -

Array with fixed value attributes (type=option and is_collection=true)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4061,
      "collection": [
        "5",
        "14"
      ]
    }
  ]
}

Attribute values example:

Key Value
id 4061
name Техника изображения
description -
is_collection true
is_required false
type option
option
option.id 5
option.value Акварель
option.id 14
option.value Акватинта
child -

Attributes with sub-attributes (type=child and is_collection=false)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4018,
      "complex": [
        {
          "id": 4068,
          "value": "Unboxing video"
        },
        {
          "id": 4074,
          "value": "JXSibCy2-As"
        }
      ]
    }
  ]
}

Attribute values example:

Key Value
id 4018
name Видеоролик
description -
is_collection false
is_required false
type child
option -
child
child.id 4068
child.name Название
child.description Наименование видеоролика на сайте
child.is_collection false
child.is_required false
child.type text
child.id 4074
child.name Код ролика на YouTube
child.description Часть ссылки на ролик с сайта youtube после watch?v=
child.is_collection false
child.is_required false
child.type text

Attributes with the array of sub-attributes (type=child and is_collection=true)

HTTP Request example:

POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "product_id": 124100,
  "attributes": [
    {
      "id": 4018,
      "complex_collection": [
        {
          "collection": [
            {
              "id": 4068,
              "value": "Additional video"
            },
            {
              "id": 4074,
              "value": "JXSibCy3-As"
            }
          ]
        },
        {
          "collection": [
            {
              "id": 4068,
              "value": "Another one video"
            },
            {
              "id": 4074,
              "value": "JXSibCy4-As"
            }
          ]
        }
      ]
    }
  ]
}

Attribute values example:

Key Value
id 4018
name Видеоролик
description -
is_collection true
is_required false
type child
option -
child
child.id 4068
child.name Название
child.description Наименование видеоролика на сайте
child.is_collection false
child.is_required false
child.type text
child.option -
child.id 4074
child.name Код ролика на YouTube
child.description Часть ссылки на ролик с сайта youtube после watch?v=
child.is_collection false
child.is_required false
child.type text
child.option -

Управление отправлениями FBS

Получить список отправлений

HTTP Request example:

POST /v2​/posting​/fbs​/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "dir": "asc",
  "filter": {
    "since": "2020-02-25T11:40:57.126Z",
    "status": "delivering",
    "to": "2020-03-25T11:40:57.126Z"
  },
  "limit": 1,
  "offset": 0,
  "with": {
    "barcodes": true
  }
}

Server Response example:

{
  "result": [
    {
      "order_id": 128903259,
      "order_number": "29750371-0013",
      "posting_number": "29750371-0013-1",
      "status": "delivering",
      "cancel_reason_id": 0,
      "created_at": "2020-02-27T11:48:08Z",
      "in_process_at": "2020-02-27T12:52:11Z",
      "shipment_date": "2020-03-06T10:00:00Z",
      "products": [
        {
          "sku": 147755222,
          "name": "Гантель неопреновая Starfit DB-201 2.5 кг. фиолетовая",
          "quantity": 2,
          "offer_id": "УТ-00009071",
          "price": "529.0000"
        }
      ],
      "barcodes": {
        "upper_barcode": "%101%168789800",
        "lower_barcode": "17736565768000"
      }
    }
  ]
}

Возвращает список отправлений за указанный период времени. Дополнительно можно отфильтровать отправления по их статусу.

Description of HTTP Request keys:

Key Type Required Description
dir str Yes Sort direction:
  • asc — ascending,
  • desc — descending.
filter array Yes Searching filter.
since datetime Yes Start of period in YYYY-MM-DD format.
status str No List of posting statuses:
  • awaiting_packaging
  • not_accepted
  • arbitration
  • awaiting_deliver
  • delivering
  • delivered
  • cancelled
to datetime Yes End of period in YYYY-MM-DD format.
limit int Yes Number of packages in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.
with array No translation missing: en.in_with
barcodes bool Yes translation missing: en.in_barcodes
shipment_date datetime No translation missing: en.in_in_shipment_date

Description of Server Response keys:

Key Type Description
order_id int ID of an order that contains the posting.
order_number str Number of an order that contains the posting.
posting_number str Posting number.
status str Posting status.
cancel_reason_id int translation missing: en.out_cancel_reason_id
created_at ddtt Date and time of package creation.
in_process_at ddtt Start date and time of shipment processing.
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
products array List of products in the posting.
sku int Products SKU.
name str Products name.
quantity int Products quantity in the posting.
offer_id str Products offer ID.
price str Products price.
barcodes obj translation missing: en.out_barcodes
upper_barcode string translation missing: en.out_upper_barcode
lower_barcode string translation missing: en.out_lower_barcode

Получить информацию об отправлении

POST /v2/posting/fbs/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
    "posting_number": "13076543-0001-1"
}

Server Response example:

{
  "result": {
    "shipment_date": "2019-11-01T13:11:13.973Z",
    "cancel_reason_id": 0,
    "created_at": "2019-11-01T13:11:13.973Z",
    "in_process_at": "2019-11-01T13:11:13.973Z",
    "order_id": 86765466,
    "order_number": "",
    "posting_number": "13076543-0001-1",
    "products": [
      {
        "name": "BLF ПЗУ",
        "offer_id": "BLF-BM12345",
        "price": "690.0000",
        "quantity": 1,
        "sku": 149512345
      }
    ],
    "status": "string"
  }
}

Возвращает информацию об отправлении по его идентификатору.

Description of HTTP Request keys:

Key Type Required Description
posting_number str Yes Posting id.

Description of Server Response keys:

Key Type Description
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
cancel_reason_Id int Cancel reason ID.
created_at ddtt Date and time of package creation.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number str Number of an order that contains the posting.
posting_number str Posting number.
products array List of products in the posting.
products.name str Products name.
products.offer_id str Products offer ID.
products.price str Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
status str Posting status.

Список необработанных отправлений

HTTP Request example:

POST /v2/posting/fbs/unfulfilled/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "dir": "asc",
  "limit": 1,
  "offset": 0,
  "status": [
    "awaiting_deliver"
  ],
  "with": {
    "barcodes": true
  }
}

Server Response example:

 {
  "result": [
    {
      "order_id": 133408799,
      "order_number": "34489339-0003",
      "posting_number": "34489339-0003-2",
      "status": "awaiting_deliver",
      "cancel_reason_id": 0,
      "created_at": "2020-03-18T21:56:43Z",
      "in_process_at": "2020-03-18T21:58:56Z",
      "shipment_date": "2020-03-26T10:00:00Z",
      "products": [
        {
          "sku": 148633547,
          "name": "Ролик для йоги и пилатеса Starfit FA-501, 15х45 см, синий/голубой",
          "quantity": 1,
          "offer_id": "УТ-00007263",
          "price": "699.0000"
        }
      ],
      "barcodes": {
        "upper_barcode": "%101%175493310",
        "lower_barcode": "17906858827000"
      }
    }
  ]
}

Возвращает список необработанных отправлений.

Description of HTTP Request keys:

Key Type Required Description
dir string Yes Sort direction:
  • asc — ascending,
  • desc — descending.
limit int Yes Number of packages in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.
status array Yes Posting status:
  • awaiting_packaging
  • not_accepted
  • awaiting_deliver
with array No translation missing: en.in_with
barcodes bool Yes translation missing: en.in_barcodes

Description of Server Response keys:

Key Type Description
order_id int ID of an order that contains the posting.
order_number str Number of an order that contains the posting.
posting_number str Posting number.
status str Posting status.
cancel_reason_id int translation missing: en.out_cancel_reason_id
created_at ddtt Date and time of package creation.
in_process_at ddtt Start date and time of shipment processing.
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
products array List of products in the posting.
sku int Products SKU.
name str Products name.
quantity int Products quantity in the posting.
offer_id str Products offer ID.
price str Products price.
barcodes obj translation missing: en.out_barcodes
upper_barcode string translation missing: en.out_upper_barcode
lower_barcode string translation missing: en.out_lower_barcode

Собрать заказ

POST /v2/posting/fbs/ship HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
    "packages": [
        {
        "items": [
            {
                "quantity": 3,
                "sku": 123065
            }
        ]
        }
    ],
    "posting_number": "13076543-0001-1"
}

Server Response example:

{
  "result": [
    "29750371-0013-1"
  ]
}

Делит заказ на отправления и переводит его в статус awaiting_deliver.
Каждый элемент items описывает отдельное отправление в заказе. Разделить заказ нужно, если:

Подробнее про сбор заказов и требования к упаковке отправлений в Помощи для партнеров.

Description of HTTP Request keys:

Key Type Required Description
packages array Yes A list of packages in the order.
items array Yes List of items in the packaging.
items.quantity str Yes Items quantity in the packaging.
items.sku int Yes Items SKU.
posting_number str Yes Posting id.

Description of Server Response keys:

Key Type Description
result str List of postings IDs.

Акт и накладная

Формирование передаточных документов: Акт приема-передачи и Транспортная накладная
Документы формируются в асинхронном режиме. Сценарий формирования:

  1. Отправляем запрос на формирование документов через метод POST /v2/posting/fbs/act/create и получаем номер задания на формирование документа
  2. Опрашиваем статус формирования документов через метод POST /v2/posting/fbs/act/check-status
  3. После получения статуса "ready" скачиваем документы через метод POST /v2/posting/fbs/act/get-pdf

Формирование акта и накладной

HTTP Request example:

POST /v2/posting/fbs/act/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{}

Server Response example:

{
  "result": {
      "id": 15684442104000
  }
}

Запускает процедуру формирования передаточных документов: акта приема-передачи и транспортной накладной

Description of Server Response keys:

Key Type Description
result.id int Номер задания на формирование документов
error.code string Ошибка при формировании задания, необходимы дополнительные действия. Возможные ошибки:
  • NOT_FOUND_IN_SORTING_CENTER: Имеются отправления, которые не были приняты на сортировочном центре. Обработайте их на вкладке «Спорные» в личном кабинете продавца и повторите попытку
  • INCLUDES_NOT_PACKAGED_POSTINGS: Имеются не собранные отправления к отгрузке сегодня. Соберите их на вкладке «Ожидают сборки» в личном кабинете продавца и повторите попытку
  • PACKAGE_TIME_ALREADY_PASSED: Мы еще принимаем заказы, которые должны быть собраны и переданы сегодня. Повторите попытку позднее

Статус акта и накладной

HTTP Request example:

POST /v2/posting/fbs/act/check-status HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "id": 15684442104000
}

Server Response example:

{
  "result": {
    "status": "ready",
    "added_to_act": [
      "00420000-0030-2",
      "01560000-0096-4"
    ],
    "removed_from_act": [
      "03840000-0096-3"
    ]
  }
}

Получение текущего статуса формирования акта приема-передачи и транспортной накладной

Description of HTTP Request keys:

Key Type Required Description
id int Yes Номер задания на формирование документов

Description of Server Response keys:

Key Type Description
result.status string Возможные статусы
  • in_process: документы в процессе формирования
  • ready: документы сформированы и готовы для скачивания
  • error: произошла ошибка при формировании документов, необходимо запросить документы повторно
result.added_to_act string array Массив номеров отправлений, которые были добавлены в Акт приема-передачи и должны быть переданы в Озон в тот же день
result.removed_from_act string array Массив номеров отправлений, которые не попали в Акт приема-передачи. Такие отправления нужно передавать со следующей отгрузкой

Получение акта и накладной

HTTP Request example:

POST /v2/posting/fbs/act/get-pdf HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "id": 15684442104000
}

Server Response example:

Pdf документ

Получить сформированные передаточные документы, а именно Акт приема-передачи и Транспортную накладную в формате PDF

Description of HTTP Request keys:

Key Type Required Description
id int Yes Номер задания на формирование документов

Напечатать маркировку

HTTP Request example:

POST /v2/posting/fbs/package-label HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "posting_number": 
  [
    "13076543-0001-1"
  ]
}

Server Response example:

Pdf документ

Генерирует PDF-файл с маркировкой для указанных отправлений. В одном запросе можно передать не больше 20 идентификаторов. Если хотя бы для одного отправления возникнет ошибка, маркировка не будет подготовлена для всех отправлений в запросе.

Description of HTTP Request keys:

Key Type Required Description
posting_number string Yes Postings ids separated with coma.

Возможные ошибки:

POSTINGS_NOT_READY — отправление не готово к маркировке, повторите попытку позже.

Открыть спор по отправлению

HTTP Request example:

POST /v2/posting/fbs/arbitration HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "posting_number": 
    [
      "02898753-0009-1", 
      "02898753-0009-2"
    ]
}

Server Response example:

{
  "result": "true"
}

Если отправление передано в доставку, но не просканированно в сортировочном центре, можно открыть спор. Открытый спор переведет отправление в статус ARBITRATION.

Description of HTTP Request keys:

Key Type Required Description
posting_number array Yes Postings ids separated with coma.

Description of Server Response keys:

Key Type Description
result bool Request result:
  • true — changes were made,
  • false — an error occurred.

Передать отправление к отгрузке

HTTP Request example:

POST /v2/posting/fbs/awaiting-delivery HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "posting_number": 
    [
        "02898753-0009-1", 
        "02898753-0009-2"
    ]
}

Server Response example:

{
  "result": "true"
}

Передает спорные заказы к отгрузке. Статус отправления изменится на awaiting_deliver.

Description of HTTP Request keys:

Key Type Required Description
posting_number array Yes Postings ids separated with coma.

Description of Server Response keys:

Key Type Description
result bool Request result:
  • true — changes were made,
  • false — an error occurred.

Отменить отправление

HTTP Request example:

POST /v2/posting/fbs/cancel HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "cancel_reason_id": 402,
  "cancel_reason_message": "Wrong seller id",
  "posting_number": 13076543-0001-1
}

Server Response example:

{
  "result": "true"
}

Меняет статус отправления на cancelled.

Description of HTTP Request keys:

Key Type Required Description
cancel_reason_id int Yes Cancel reason id:
  • 352 — product is out of stock,
  • 400 — only defected products left,
  • 402 — other reason.
cancel_reason_message str No Additional information about cancellation. Required if cancel_reason_id=402.
posting_number str Yes Postings ids separated with coma.

Description of Server Response keys:

Key Type Description
result bool Request result:
  • true — changes were made,
  • false — an error occurred.

Получить причины отмены

HTTP Request example:

POST /v2/posting/fbs/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
}

Server Response example:

{
  "result": [
    {
      "id": 123,
      "title": "Error",
      "type_id": "seller"
    }
  ]
}

Возвращет список причин отмены отправлений.

Description of Server Response keys:

Key Type Description
result array List of postings IDs.
result.id int ID of a cancellation reason.
result.title str Description on a cancellation reason.
result.type_id str Initiator of posting cancellation:
  • buyer
  • seller

Отправления со склада Ozon

Список отправлений

HTTP Request example:

POST /v2/posting/fbo/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{ 
    "dir": "asc", 
    "filter": 
    { 
        "since": "2018-10-24T16:24:09.474Z", 
        "to": "2019-10-24T16:24:09.474Z" 
    }, 
    "limit": 10,
    "offset": 0
}

Server Response example:

{
  "result": 
  [
    {
      "order_id": 77712345,
      "order_number": "",
      "posting_number": "25312345-0021-2",
      "status": "cancelled",
      "cancel_reason_id": 76,
      "created_at": "2019-03-21T14:51:01Z",
      "in_process_at": "2019-03-21T14:52:07Z",       
      "products": 
      [
        {
          "sku": 149123456,
          "name": "AUX аудиокабель 3.5мм",
          "quantity": 1,
          "offer_id": "DEP-12345",
          "price": "270.0000"
        }
      ]
    }
  ]
}

Возвращает список отправлений за указанный период времени. Дополнительно можно отфильтровать отправления по их статусу.

Description of HTTP Request keys:

Key Type Required Description
dir str Yes Sort direction:
  • asc — ascending,
  • desc — descending.
filter array Yes Searching filter.
since datetime Yes Start of period in YYYY-MM-DD format.
to datetime Yes End of period in YYYY-MM-DD format.
status str No Posting status:
  • awaiting_approve
  • awaiting_packaging
  • awaiting_deliver
  • delivering
  • delivered
  • cancelled
limit int Yes Number of packages in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.

Description of Server Response keys:

Key Type Description
cancel_reason_Id int Cancel reason ID.
created_at ddtt Date and time of package creation.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number str Number of an order that contains the posting.
posting_number str Posting number.
products array List of products in the posting.
products.name str Products name.
products.offer_id str Products offer ID.
products.price str Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
status str Posting status.

Информация об отправлении

HTTP Request example:

POST /v2/posting/fbo/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
    "posting_number": "13009555-0001-1"
}

Server Response example:

{
  "result": 
  {
    "order_id": 86765466,
    "order_number": "",
    "posting_number": "13076543-0001-1",
    "status": "cancelled",
    "cancel_reason_id": 0,
    "created_at": "2019-05-31T19:22:34Z",
    "in_process_at": "2019-05-31T19:53:01Z",
    "products": 
    [
      {
        "sku": 149512345,
        "name": "BLF ПЗУ",
        "quantity": 1,
        "offer_id": "BLF-BM12345",
        "price": "690.0000"
      }
    ]
  }
}

Возвращает информацию об отправлении по его идентификатору.

Description of HTTP Request keys:

Key Type Required Description
posting_number str Yes Posting id.

Description of Server Response keys:

Key Type Description
cancel_reason_Id int Cancel reason ID.
created_at ddtt Date and time of package creation.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number str Number of an order that contains the posting.
posting_number str Posting number.
products array List of products in the posting.
products.name str Products name.
products.offer_id str Products offer ID.
products.price str Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
status str Posting status.

Crossborder

List of Orders

HTTP Request example:

POST /v2/posting/crossborder/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "dir": "asc",
  "filter": {
    "since": "2018-11-18T11:27:45.154Z",
    "status": "awaiting_approve",
    "to": "2019-11-18T11:27:45.154Z"
  },
  "limit": 10,
  "offset": 0
}

Server Response example:

{
  "result": [
    {
      "address": {
        "address_tail": "г. Москва, ул. Центральная, 1",
        "addressee": "Петров Иван Владимирович",
        "city": "Москва",
        "comment": "",
        "country": "Россия",
        "district": "",
        "phone": "+7 495 123-45-67",
        "region": "Москва",
        "zip_code": "101000"
      },
      "auto_cancel_date": "2019-11-18T11:30:11.571Z",
      "cancel_reason_id": 76,
      "created_at": "2019-11-18T11:30:11.571Z",
      "customer_email": "petrov@email.com",
      "customer_id": 60006,
      "in_process_at": "2019-11-18T11:30:11.571Z",
      "order_id": 77712345,
      "order_nr": "1111444",
      "posting_number": "39268230-0002-3",
      "products": [
        {
          "name": "Фитнес-браслет",
          "offer_id": "DEP-1234",
          "price": "1900.00",
          "quantity": 1,
          "sku": 100056
        }
      ],
      "shipping_provider_id": 0,
      "status": "awaiting_approve",
      "tracking_number": ""
    }
  ]
}

Returns a list of orders filtered by date and status.

Description of HTTP Request keys:

Key Type Required Description
dir string Yes Sort direction:
  • asc — ascending,
  • desc — descending.
filter object Yes Searching filter.
filter.since ddtt No Start of period in YYYY-MM-DD format.
filter.status string No Posting status:
  • awaiting_approve
  • awaiting_packaging
  • awaiting_deliver
  • delivering
  • delivered
  • cancelled
filter.to ddtt No End of period in YYYY-MM-DD format.
limit int Yes Number of packages in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.

Description of Server Response keys:

Key Type Description
address array Address info array
address.address_tail string Address
address.addressee string Customer Name/Lastname
address.city string Delivery city
address.comment string Delivery comments
address.country string Delivery country
address.district string Delivery district
address.phone string Phone number
address.region string Region
address.zip_code string ZIP code
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
cancel_reason_id int Cancel reason ID.
created_at ddtt Date and time of package creation.
customer_email string Customer email.
customer_id int Customer ID.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number string Number of an order that contains the posting.
posting_number string Posting number.
products array List of products in the posting.
products.name string Products name.
products.offer_id string Products offer ID.
products.price string Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
shipping_provider_id int Shipping provider ID.
status string Posting status.
tracking_number string Tracking number.

Order Info

HTTP Request example:

POST /v2/posting/crossborder/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "posting_number": "39268230-0002-3",
}

Server Response example:

{
  "result": [
    {
      "address": {
        "address_tail": "г. Москва, ул. Центральная, 1",
        "addressee": "Петров Иван Владимирович",
        "city": "Москва",
        "comment": "",
        "country": "Россия",
        "district": "",
        "phone": "+7 495 123-45-67",
        "region": "Москва",
        "zip_code": "101000"
      },
      "auto_cancel_date": "2019-11-18T11:30:11.571Z",
      "cancel_reason_id": 76,
      "created_at": "2019-11-18T11:30:11.571Z",
      "customer_email": "petrov@email.com",
      "customer_id": 60006,
      "in_process_at": "2019-11-18T11:30:11.571Z",
      "order_id": 77712345,
      "order_nr": "1111444",
      "posting_number": "39268230-0002-3",
      "products": [
        {
          "name": "Фитнес-браслет",
          "offer_id": "DEP-1234",
          "price": "1900.00",
          "quantity": 1,
          "sku": 100056
        }
      ],
      "shipping_provider_id": 0,
      "status": "awaiting_approve",
      "tracking_number": ""
    }
  ]
}

Returns a full description of the order by its id.

Description of HTTP Request keys:

Key Type Required Description
posting_number str Yes Posting id.

Description of Server Response keys:

Key Type Description
address array Address info array
address.address_tail string Address
address.addressee string Customer Name/Lastname
address.city string Delivery city
address.comment string Delivery comments
address.country string Delivery country
address.district string Delivery district
address.phone string Phone number
address.region string Region
address.zip_code string ZIP code
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
cancel_reason_id int Cancel reason ID.
created_at ddtt Date and time of package creation.
customer_email string Customer email.
customer_id int Customer ID.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number string Number of an order that contains the posting.
posting_number string Posting number.
products array List of products in the posting.
products.name string Products name.
products.offer_id string Products offer ID.
products.price string Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
shipping_provider_id int Shipping provider ID.
status string Posting status.
tracking_number string Tracking number.

List of Packages for Shipment

HTTP Request example:

POST /v2/posting/crossborder/unfulfilled/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "dir": "asc",
  "limit": 10,
  "offset": 0,
  "status": [
    "awaiting_packaging"
  ]
}

Server Response example:

{
  "result": [
    {
      "address": {
        "address_tail": "г. Москва, ул. Центральная, 1",
        "addressee": "Петров Иван Владимирович",
        "city": "Москва",
        "comment": "",
        "country": "Россия",
        "district": "",
        "phone": "+7 495 123-45-67",
        "region": "Москва",
        "zip_code": "101000"
      },
      "auto_cancel_date": "2019-11-18T11:30:11.571Z",
      "cancel_reason_id": 76,
      "created_at": "2019-11-18T11:30:11.571Z",
      "customer_email": "petrov@email.com",
      "customer_id": 60006,
      "in_process_at": "2019-11-18T11:30:11.571Z",
      "order_id": 77712345,
      "order_nr": "1111444",
      "posting_number": "39268230-0002-3",
      "products": [
        {
          "name": "Фитнес-браслет",
          "offer_id": "DEP-1234",
          "price": "1900.00",
          "quantity": 1,
          "sku": 100056
        }
      ],
      "shipping_provider_id": 0,
      "status": "awaiting_approve",
      "tracking_number": ""
    }
  ]
}

Returns a list of packages that are ready for shipping (status awaiting_packaging).

Description of HTTP Request keys:

Key Type Required Description
dir string Yes Sort direction:
  • asc — ascending,
  • desc — descending.
limit int Yes Number of packages in response.
offset int Yes An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.
status array Yes List of posting statuses:
  • awaiting_packaging
  • not_accepted
  • arbitration
  • awaiting_deliver
  • delivering
  • delivered
  • cancelled

Description of Server Response keys:

Key Type Description
address array Address info array
address.address_tail string Address
address.addressee string Customer Name/Lastname
address.city string Delivery city
address.comment string Delivery comments
address.country string Delivery country
address.district string Delivery district
address.phone string Phone number
address.region string Region
address.zip_code string ZIP code
shipment_date ddtt Date and time before which package should be shipped.
If the package is not ready for that date — it will be automatically canceled.
cancel_reason_id int Cancel reason ID.
created_at ddtt Date and time of package creation.
customer_email string Customer email.
customer_id int Customer ID.
in_process_at ddtt Start date and time of shipment processing.
order_id int ID of an order that contains the posting.
order_number string Number of an order that contains the posting.
posting_number string Posting number.
products array List of products in the posting.
products.name string Products name.
products.offer_id string Products offer ID.
products.price string Products price.
products.quantity int Products quantity in the posting.
products.sku int Products SKU.
shipping_provider_id int Shipping provider ID.
status string Posting status.
tracking_number string Tracking number.

Order Shipping

HTTP Request example:

POST /v2/posting/crossborder/ship HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "items": [
    {
      "quantity": 2,
      "sku": 100056
    }
  ],
  "posting_number": "39268230-0002-3",
  "shipping_provider_id": 15109877837000,
  "tracking_number": "AB123456CD"
}

Server Response example:

{
  "result": {
    "package_number": "232123"
  }
}

Split order into packages and select a shipping provider. Order status will be changed to awaiting_deliver.
Every items element describes separate package in the order. You should split an order if:

Description of HTTP Request keys:

Key Type Required Description
items object Yes List of items in the packaging.
items.quantity int Yes Items quantity in the packaging.
items.sku int Yes Items SKU.
posting_number string Yes Posting id.
shipping_provider_id int Yes Shipping provider ID.
tracking_number string Yes Tracking number.

Description of Server Response keys:

Key Type Description
result string Request result.

List of Shipping Providers

HTTP Request example:

POST /v2/posting/crossborder/shipping-provider/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
}

Server Response example:

{
  "result": [
    {
      "id": 15109877837000,
      "name": "shiptor"
    },
    {
      "id": 15308950689000,
      "name": "china-post"
    }
  ]
}

Returns a list of accepted shipping providers.

Description of Server Response keys:

Key Type Description
result array List of accepted shipping providers.
id int Shipping provider ID.
name string Shipping provider name.

Approve Order

HTTP Request example:

POST /v2/posting/crossborder/approve HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
    "posting_number": "13009555-0001-1"
}

Server Response example:

{
  "result": true
}

Confirm an order for packaging.

Description of HTTP Request keys:

Key Type Required Description
posting_number str Yes Posting id.

Description of Server Response keys:

Key Type Description
result boolean Request result:
  • true — changes were made,
  • false — an error occurred.

Cancel Order

HTTP Request example:

POST /v2/posting/crossborder/cancel HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "cancel_reason_id": 361,
  "cancel_reason_message": "",
  "posting_number": "39268230-0002-3",
  "sku": [
    149123456
  ]
}

Server Response example:

{
  "result": true
}

Cancel the order or particular items by their id.

Description of HTTP Request keys:

Key Type Required Description
cancel_reason_id int Yes Cancel reason id:
  • 352 — product is out of stock,
  • 400 — only defected products left,
  • 402 — other reason.
cancel_reason_message string No Additional information about cancellation. Required if cancel_reason_id=402.
posting_number string Yes Posting id.
sku int No List of items SKU in posting.

Description of Server Response keys:

Key Type Description
result boolean Request result:
  • true — changes were made,
  • false — an error occurred.

Get cancellation reasons

POST /v2/posting/crossborder/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
}

Server Response example:

{
  "result": [
    {
      "id": 361,
      "title": "Other",
      "type_id": "buyer"
    },
    {
      "id": 352,
      "title": "Product is out of stock",
      "type_id": "seller"
    }
  ]
}

Returns a list of possible cancellation reasons.

Description of Server Response keys:

Key Type Description
result boolean List of reasons for cancellation.
result.id int ID of a cancellation reason.
result.title string Description on a cancellation reason.
result.type_id string Initiator of posting cancellation:
  • buyer
  • seller

Chat with customer

Enables a seller - buyer interaction related to any order using API.

As a seller, you can use the following features:

  1. Retreive chat list
  2. Retreive chat message history
  3. Retreive chat updates
  4. Create a new chat
  5. Send files and messages in an existing chat

Chat list

HTTP Request example:

POST /v1/chat/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "chat_id_list": [
    "6639ec81-616e-480d-82b6-111dec41f674",
    "3cdf5407-9f90-4752-8105-8f1d4cd427f5"
  ],
  "page": 1,
  "page_size": 100
}

Server Response example:

{
  "result": [
    {
      "id": "6639ec81-616e-480d-82b6-111dec41f674",
      "users": [
        {
          "id": "501",
          "type": "seller"
        },
        {
          "id": "5mzh1lzfuhq4jcs2ufoxpnoa",
          "type": "customer"
        }
      ],
      "last_message_id": "1933333401419385131"
    },
    {
      "id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
      "users": [
        {
          "id": "501",
          "type": "seller"
        },
        {
          "id": "31494738",
          "type": "customer"
        }
      ],
      "last_message_id": "1933404740364797568"
    }
  ]
}

Retrieves a list of chats in which a seller participates

Description of HTTP Request keys:

Key Type Required Description
chat_id_list string array No Chat ID filter
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 100, maximum is 1000 orders on the page

Description of Server Response keys:

Key Type Description
id string Unique chat ID
users array Chat members array
users.id string Unique chat member ID
users.type string Chat member type, possible value are: "customer", "seller", "crm", "courier"
last_message_id string Chat last message ID

Chat history

HTTP Request example:

POST /v1/chat/history HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
  "from_message_id": "986714",
  "limit": 10
}

Server Response example:

{
  "result": [
    {
      "context": {
        "item": {
          "sku": 0
        },
        "order": {
          "order_number": "123456-0001",
          "postings": [
            {
              "delivery_schema": "fbs",
              "posting_number": "13076543-0001-1",
              "sku_list": [
                149512345
              ]
            }
          ]
        }
      },
      "created_at": "2019-11-25T10:43:06.518Z",
      "file": {
        "url": "http://api-seller.ozon.ru/v1/chat/file/3cdf5407-9f90-4752-8105-8f1d4cd427f563f87e6da3651007ab96185f38772032b3918e31.jpg",
        "mime": "image/jpeg",
        "size": 815313,
        "name": "32679625.jpg"
      },
      "id": "1931356687558511593",
      "text": "hello",
      "type": "file",
      "user": {
        "id": "30735682",
        "type": "customer"
      }
    }
  ]
}

Retreives message history in a chat.

By default old messages are shown first. In order to show new messages first, please use /v1/chat/updates method, which has the same structure as this one

Description of HTTP Request keys:

Key Type Required Description
chat_id string Yes Unique chat ID
from_message_id string No Show only messages newer than a specific message ID
limit int No translation missing: en.in_linit_messages

Description of Server Response keys:

Key Type Description
context object translation missing: en.out_context
context.item object translation missing: en.out_item
item.sku int translation missing: en.out_sku
context.order object translation missing: en.out_order
order.order_number string Number of an order that contains the posting.
order.postings object translation missing: en.out_postings
postings.delivery_schema string translation missing: en.out_delivery_schema_2
postings.posting_number string Posting number.
postings.sku_list array translation missing: en.out_sku_list
created_at ddtt translation missing: en.out_created_at_chat
file object translation missing: en.out_file
file.mime string File MIME type (Content-type)
file.name string File name
file.size int File size, in bytes
file.url string File URL
id string Unique message ID
text string Message, filled only for type=text
type string Message type, possible value are: "text", "file"
user array Message author info
user.id string Unique chat member ID
user.type string Chat member type, possible value are: "customer", "seller", "crm", "courier"

Send a message

HTTP Request example:

POST /v1/chat/send/message HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
  "text": "Test Message"
}

Server Response example:

{
  "result": "success"
}

Sends a message in an existing chat with a customer

Description of HTTP Request keys:

Key Type Required Description
chat_id string Yes Unique chat ID
text string Yes Message text in plain text format

Description of Server Response keys:

Key Type Description
result string Request result.

Send a file

HTTP Request example:

POST /v1/chat/send/file HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
  "base64_content": "MSwgMiwgMwo=",
  "name": "test.txt"
}

Server Response example:

{
  "result": "success"
}

Sends a file in an existing chat with a customer

Description of HTTP Request keys:

Key Type Required Description
base64_content string Yes File encoded in base64 string
chat_id string Yes Unique chat ID
name string Yes File name with extension

Description of Server Response keys:

Key Type Description
result string Result status

New chat

HTTP Request example:

POST /v1/chat/start HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "posting_number": 598586936
}

Server Response example:

{
  "result": {
    "chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5"
  }
}

Creates a new chat with a customer related to a specific posting. For example, if a seller has some questions regarding delivery address, he can simply contact a buyer via new chat

Description of HTTP Request keys:

Key Type Required Description
posting_number string Yes Posting id.

Description of Server Response keys:

Key Type Description
result.chat_id string Unique chat ID

Promotional offers

Partner can promote products by participating in promotional offers that Ozon regularly hold for customers. You can add products via Seller Center, XLS File or API.

Promotional offers list

HTTP Request example:

GET /v1/actions HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json

Server Response example:

{
  "result": [
    {
      "action_id": 2328,
      "title": "акция пагинация",
      "date_start": "2020-01-21T13:30:06Z",
      "date_end": "2020-01-30T21:00:00Z",
      "potential_products_count": 3,
      "is_participating": false,
      "participating_products_count": 0,
      "action_type": "DISCOUNT",
      "banned_products_count": 1,
      "with_targeting": false
    }
  ]
}

Returns a list of promotional offers in which products can participate.

Description of Server Response keys:

Key Type Description
action_id int Promotional offer ID.
title string Promotional offer title.
date_start string Promotional offer start date.
date_end string Promotional offer end date.
potential_products_count int Number of products which can participate in the promotional offer.
is_participating bool Partner participation in the promotional offer.
participating_products_count int Number of products which participate in the promotional offer.
description string Promotional offer description.
action_type string Promotional offer type:
  • DISCOUNT — the discount depends on the value of products.action_price, which partner passes in method Add product to the promotional offer.
  • NTH_FOR_FREE — the discount doesn't depend on the value of products.action_price and is equal to 33%.
banned_products_count int Number of products which are blocked.
with_targeting bool Promotional offer with a target audience.

List of products which can participate in the promotional offer

HTTP Request example:

POST /v1/actions/candidates HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json

{
  "action_id": 2422,
  "limit": 1,
  "offset": 0
}

Server Response example:

{
  "result": {
    "products": [
      {
        "product_id": 15323889,
        "price": 1100,
        "action_price": 1100,
        "max_action_price": 1100
      }
    ],
    "total": 1
  }
}

Returns a list of products which can participate in the promotional offer.

Description of HTTP Request keys:

Key Type Required Description
action_id int Yes Promotional offer ID.
limit int No Number of products in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.

Description of Server Response keys:

Key Type Description
products array List of products which can participate in the promotional offer.
products.product_id int Item ID.
products.price float Current price before discount.
products.action_price float Promotional price.
products.max_action_price float The most possible promotional price.
total int Number of products which can participate in the promotional offer.

List of products which participate in the promotional offer

HTTP Request example:

POST /v1/actions/products HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json

{
  "action_id": 2422,
  "limit": 1,
  "offset": 0
}

Server Response example:

{
  "result": {
    "products": [
      {
        "product_id": 15323889,
        "price": 1100,
        "action_price": 1100,
        "max_action_price": 1100
      }
    ],
    "total": 1
  }
}

Returns a list of products which participate in the promotional offer.

Description of HTTP Request keys:

Key Type Required Description
action_id int Yes Promotional offer ID.
limit int No Number of products in response.
offset int No An offset into the list of returned items.
For example, if offset=10 then response will contain items starting from 11th.

Description of Server Response keys:

Key Type Description
products array List of products which participate in the promotional offer.
products.product_id int Item ID.
products.price float Current price before discount.
products.action_price float Promotional price.
products.max_action_price float The most possible promotional price.
total int Number of products which participate in the promotional offer.

Add product to the promotional offer

HTTP Request example:

POST /v1/actions/products/activate HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json

{
  "action_id": 2422,
  "products": [
    {
      "product_id": 15323889,
      "action_price": 931.00
    }
  ]
}

Server Response example:

{
  "result": {
    "product_ids": [
      15323889
    ]
  }
}

This method allows to add products to the promotional offer.

Description of HTTP Request keys:

Key Type Required Description
action_id int Yes Promotional offer ID.
products array Yes List of products to add to the promotional offer.
products.product_id int Yes Item ID.
products.action_price float Yes Promotional price. In rubles and rounded to the nearest hundredth.

Description of Server Response keys:

Key Type Description
product_ids array List of products ID added to the promotional offer.

Delete product from the promotional offer

HTTP Request example:

POST /v1/actions/products/deactivate HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json

{
  "action_id": 2422,
  "product_ids": [
    15323889
  ]
}

Server Response example:

{
  "result": {
    "product_ids": [
      15323889
    ]
  }
}

This method allows to delete products from the promotional offer.

Description of HTTP Request keys:

Key Type Required Description
action_id int Yes Promotional offer ID.
product_ids array Yes List of products to delete from the promotional offer.

Description of Server Response keys:

Key Type Description
product_ids array List of products ID deleted from the promotional offer.

API reports

Allows to retrieve reports via API, that are also available in Seller Center.

Following API methods are present:

  1. Reports list
  2. Report info
  3. Products report
  4. Transactions report

translation missing: en.title_transactions

translation missing: en.description_finance

translation missing: en.transaction_list

translation missing: en.description_transaction_list

HTTP Request example:

POST /v2/finance/transaction/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "filter": {
    "date": {
      "from": "2020-03-01T07:14:11.897Z",
      "to": "2020-03-31T07:14:11.897Z"
    },
    "posting_number": "37634761-0032-2",
    "transaction_type": "all"
  },
  "page": 1,
  "page_size": 10
}

Server Response example:

{
  "result": [
    {
      "transactionNumber": 11063698936370,
      "orderDate": "2019-10-09T00:00:00Z",
      "orderNumber": "37634761-0032-2",
      "transactionType": "Возврат",
      "details": "Фитнес браслет Samsung R375 GalaxyFit E black",
      "orderAmount": -2980,
      "discountAmount": 0,
      "commissionAmount": 368.03,
      "totalAmount": -2611.97,
      "orderState": "",
      "tranDate": "2020-03-05T00:00:00Z",
      "transactionTypeSlug": "returns",
      "itemDeliveryAmount": 0,
      "itemReturnAmount": 0
    }
  ]
}

Description of HTTP Request keys:

Key Type Required Description
filter strinf Yes translation missing: en.in_filter3
date date Yes translation missing: en.in_date
from ddtt Yes translation missing: en.in_from
to ddtt Yes End of period in YYYY-MM-DD format.
posting_number string No Posting id.
transaction_type string Yes translation missing: en.in_transaction_type
page int Yes Page number in response.
page_size int Yes Amount of attributes on the page.

Description of Server Response keys:

Key Type Description
transactionNumber int translation missing: en.out_transactionNumber
orderDate string translation missing: en.out_orderDate
orderNumber string Customer order number
transactionType string translation missing: en.out_transactionType
details string translation missing: en.out_details
orderAmount int translation missing: en.out_orderAmount
discountAmount int translation missing: en.out_discountAmount
commissionAmount int translation missing: en.out_commissionAmount
totalAmount int translation missing: en.out_totalAmount
orderState string translation missing: en.out_orderState
tranDate ddtt translation missing: en.out_tranDate
transactionTypeSlug string translation missing: en.out_transactionTypeSlug
itemDeliveryAmount int translation missing: en.out_itemDeliveryAmount
itemReturnAmount int translation missing: en.out_itemReturnAmount

translation missing: en.transaction_total

translation missing: en.description_transaction_total

HTTP Request example:

POST /v2/finance/transaction/totals HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "filter": {
    "date": {
      "from": "2020-03-01T07:14:11.897Z",
      "to": "2020-03-31T07:14:11.897Z"
    },
    "posting_number": "37634761-0032-2",
    "transaction_type": "all"
  },
  "page": 1,
  "page_size": 10
}

Server Response example:

{
  "result": {
    "orderAmount": "720314.00",
    "discountAmount": "0.00",
    "commissionAmount": "-42661.10",
    "totalAmount": "677652.88",
    "item_delivery_amount": "-9597.00",
    "item_return_amount": "0.00"
  },
  "error": null
}

Description of HTTP Request keys:

Key Type Required Description
filter strinf Yes translation missing: en.in_filter3
date date Yes translation missing: en.in_date
from ddtt Yes translation missing: en.in_from
to ddtt Yes End of period in YYYY-MM-DD format.
posting_number string No Posting id.
transaction_type string Yes translation missing: en.in_transaction_type
page int Yes Page number in response.
page_size int Yes Amount of attributes on the page.

Description of Server Response keys:

Key Type Description
orderAmount int translation missing: en.out_orderAmount
discountAmount string translation missing: en.out_discountAmount
commissionAmount string translation missing: en.out_commissionAmount
totalAmount string translation missing: en.out_totalAmount
item_delivery_amount string translation missing: en.out_item_delivery_amount
item_return_amount int translation missing: en.out_item_return_amount
error int translation missing: en.out_error

Reports list

HTTP Request example:

POST /v1/report/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "page": 1,
  "page_size": 100,
  "report_type": "SELLER_TRANSACTIONS"
}

Server Response example:

{
  "result": {
    "reports": [
      {
        "code": "63d60fd4-1959-4087-89fa-2afa320eb2fb",
        "status": "success",
        "error": "",
        "file": "http://api-seller.ozon.ru/v1/report/file/a7/76/a776a9c05f1c5e67.csv",
        "report_type": "seller_transactions",
        "params": {
          "date_from": "2019-01-01",
          "date_to": "2019-01-15",
          "search": "",
          "transaction_type": ""
        },
        "created_at": "2019-01-23T10:22:46.414747Z"
      }
    ],
    "total": 1
  }
}

Returns a list of reports which were previously generated by Seller

Description of HTTP Request keys:

Key Type Required Description
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 100, maximum is 1000 orders on the page
report_type string No Report type filter, possible values are: "SELLER_PRODUCTS", "SELLER_TRANSACTIONS"

Description of Server Response keys:

Key Type Description
reports array Array with all generated reports
code string Report unique ID
status string Report generation status, possible values are: "success", "failed"
error string Error code, if present
file string CSV file link
report_type string Report type filter, possible values are: "SELLER_PRODUCTS", "SELLER_TRANSACTIONS"
params array Array with filters used during report generation
created_at string Report creation date
total int Total number of reports

Report info

HTTP Request example:

POST /v1/report/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "code": "63d60fd4-1959-4087-89fa-2afa320eb2fb"
}

Server Response example:

{
    "result": {
        "code": "63d60fd4-1959-4087-89fa-2afa320eb2fb",
        "status": "success",
        "error": "",
        "file": "http://api-seller.ozon.ru/v1/report/file/a7/76/a776a9c05f1c5e67.csv",
        "report_type": "seller_transactions",
        "params": {
            "date_from": "2019-01-01",
            "date_to": "2019-01-15",
            "search": "",
            "transaction_type": ""
        },
        "created_at": "2019-01-23T10:22:46.414747Z"
    }
}

Get report info by unique ID

Description of HTTP Request keys:

Key Type Required Description
code string No Report unique ID

Description of Server Response keys:

Key Type Description
code string Report unique ID
status string Report generation status, possible values are: "success", "failed"
error string Error code, if present
file string CSV file link
report_type string Report type filter, possible values are: "SELLER_PRODUCTS", "SELLER_TRANSACTIONS"
params array Array with filters used during report generation
created_at string Report creation date

Products report

HTTP Request example:

POST /v1/report/products/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "offer_id": [
    "GJ5O52T5"
  ],
  "search": "SAMSUNG",
  "sku": [
    555929582
  ],
  "visibility": "VISIBLE"
}

Server Response example:

{
    "result": {
        "code": "da9af288-2724-4f0e-8b15-37cf061d4817"
    }
}

Returns products reports, which is also available in Seller Center

Description of HTTP Request keys:

Key Type Required Description
offer_id string array No Product ID in Seller's ERP
search string No Entry search
sku int array No Unique product Ozon ID
visibility string No Product visibility filter, possible values:
  • ALL: all products
  • VISIBLE: products, visible for customers
  • INVISIBLE: products, invisible for customers for some reason
  • EMPTY_STOCK: products with empty stock
  • READY_TO_SUPPLY: products with empty stock and state=processed (so you can set stock)
  • STATE_FAILED: products which are failed on some step

Description of Server Response keys:

Key Type Description
code string Report unique ID

Transactions report

HTTP Request example:

POST /v1/report/transactions/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "date_from": "2019-01-01",
  "date_to": "2019-01-15",
  "search": "MEIZU",
  "transaction_type": "ORDERS"
}

Server Response example:

{
    "result": {
        "code": "da9af288-2724-4f0e-8b15-37cf061d4817"
    }
}

Returns products reports, which is also available in Seller Center

Description of HTTP Request keys:

Key Type Required Description
date_from string Yes Start date, used for transactions report. Should be formatted as YYYY-MM-DD
date_to string Yes End date, used for transactions report. Should be formatted as YYYY-MM-DD
search string No Entry search
transaction_type string No Transaction type finter, possible values are: "ALL", "ORDERS", "RETURNS", "SERVICES", "OTHER", "DEPOSIT"

Description of Server Response keys:

Key Type Description
code string Report unique ID

Obsolete API Version

Order info

HTTP Request example:

GET /v1/order/123456?translit=true HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

Server Response example:

{
  "result": {
    "order_id": 123456,
    "order_number": "123456-0001",
    "status": "delivered",
    "customer_id": 122334,
    "delivery_schema": "fbo",
    "last_updated": "2018-09-25T12:41:48.932Z",
    "order_time": "2018-09-25T12:41:48.932Z",
    "address": {
      "address_tail": "Vlogogradskaya st. 12 - 23",
      "addressee": "Ivan Ivanov",
      "city": "Moscow",
      "comment": "pass code #123",
      "country": "Russia",
      "district": "Central",
      "phone": "7903XXXXXXX",
      "email": "test@ozon.ru",
      "region": "Moscow",
      "zip_code": "112334"
    },
    "items": [
      {
        "product_id": 124525,
        "item_id": 325441,
        "quantity": 1,
        "offer_id": "124100",
        "price": "79999",
        "tracking_number": "XZY1111111",
        "status": "delivered",
        "cancel_reason_id": 0,
        "auto_cancel_date": "2019-01-09T09:56:53.587Z",
        "shipping_provider_id": 5
      }
    ]
  }
}

Receive order info.

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID
translit bool No Address transliteration into Latin characters

Description of Server Response keys:

Key Type Description
order_id int Order ID
order_number string Customer order number
status string Order status
customer_id int Customer ID
delivery_schema string Order delivery schema, possible values: "fbo", "fbs", "crossborder"
last_updated string Last update date
order_time string Order create date
address array Address info array
address.address_tail string Address
address.addressee string Customer Name/Lastname
address.city string Delivery city
address.comment string Delivery comments
address.country string Delivery country
address.district string Delivery district
address.phone string Phone number
address.email string E-mail
address.region string Region
address.zip_code string ZIP code
items array Order items array
items.product_id int Unique item ID
items.item_id int Order item ID
items.quantity int Items quantity
items.offer_id string Product ID in Seller's ERP
items.price string Item price after discounts
items.tracking_number string Shipment tracking number
items.status string Item status in an order
items.cancel_reason_id int Cancellation reason code
items.auto_cancel_date string Order automatic cancellation date
items.shipping_provider_id int Shipping company (provider) ID

Order list

HTTP Request example:

POST /v1/order/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "since": "2018-12-19T14:39:46.033Z",
  "to": "2018-12-19T14:39:46.033Z",
  "delivery_schema": "fbs",
  "statuses": ["DELIVERED"],
  "page": 1,
  "page_size": 100
}

Server Response example:

{
  "result": {
    "orders": [
      {
        "order_id": 19294655,
        "delivery_schema": "fbo",
        "status": "cancelled",
        "items": [
          {
            "item_id": 67696756,
            "product_id": 28987,
            "offer_id": "02905340-43",
            "cancel_reason_id": 0,
            "quantity": 1
          }
        ]
      },
      {
        "order_id": 19305509,
        "delivery_schema": "fbo",
        "status": "delivered",
        "items": [
          {
            "item_id": 67735563,
            "product_id": 29187,
            "offer_id": "25605010-37",
            "cancel_reason_id": 0,
            "quantity": 2
          }
        ]
      }
    ],
    "total": 121
  }
}

Receive the list of orders.

Description of HTTP Request keys:

Key Type Required Description
since string Yes Date filter, from, format: YYYY-MM-DD
to string Yes Date filter, to, format: YYYY-MM-DD
delivery_schema string Yes Order delivery scheme, possible values: "fbs", "fbo", "crossborder"
statuses string array No Order status, possible values: "AWAITING_APPROVE", "AWAITING_PACKAGING", "AWAITING_DELIVER", "DELIVERING", "DELIVERED", "CANCELLED"
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 100, maximum is 1000 orders on the page

Description of Server Response keys:

Key Type Description
result array List of order IDs
result.total int Total items
orders.order_id int Order ID
orders.delivery_schema string Order delivery schema, possible values: "fbo", "fbs", "crossborder"
orders.status string Order status
orders.items array Order items array
orders.items.product_id int Unique item ID
orders.items.item_id int Order item ID
orders.items.offer_id string Product ID in Seller's ERP
orders.items.quantity string Items quantity
orders.items.cancel_reason_id int Cancellation reason code

Unfulfilled orders

HTTP Request example:

POST /v1/order/unfulfilled HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "page": 1,
  "page_size": 10
}

Server Response example:

{
  "result": [
    {
      "order_id": 123456,
      "items": [
        {
          "item_id": 12345,
          "product_id": 123456,
          "offer_id": "PRD-123",
          "quantity": 2
        }
      ]
    }
  ],
  "total": 121
}

Receive the list of unfulfilled orders, within the specified order date and time.

Description of HTTP Request keys:

Key Type Required Description
page int No Filter by page number
page_size int No Filter by the number of products on the page. Default setting is 100, maximum is 1000 orders on the page

Description of Server Response keys:

Key Type Description
result array List of order IDs
total int Total items
result.order_id int Order ID
result.items array Order items array
items.item_id int Order item ID
items.product_id int Item ID.
items.offer_id string Product ID in Seller's ERP
items.quantity string Items quantity

Approve items for CB

HTTP Request example:

POST /v1/order/approve/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_id": 123456
}

Server Response example:

{
  "result": "success"
}

Approve items in the order. Changes approval status for specific items in the order.

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID

Description of Server Response keys:

Key Type Description
result string Result status

Shipping providers for CB

HTTP Request example:

POST /v1/order/shipping-provider/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{}

Server Response example:

{
  "result": [
    {
      "id": 1,
      "name": "DPD"
    },
    {
      "id": 2,
      "name": "USPS"
    }
  ]
}

Receive the list of available shipping providers.

Description of Server Response keys:

Key Type Description
result array List of order IDs
id int Shipping company (provider) ID
name string Product name. Up to 500 characters

Order shipping for CB

HTTP Request example:

POST /v1/order/ship/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_id": 123456,
  "shipping_provider_id": 2,
  "tracking_number": "AA123456789AA",
  "items": [
    {
      "item_id": 123,
      "quantity": 1
    }
  ]
}

Server Response example:

{
  "result": {
    "package_number": "232123"
  }
}

Create a package, mark it as dispatched and provide a tracking number.

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID
tracking_number string Yes Shipment tracking number
shipping_provider_id int Yes Shipping company (provider) ID
items array Yes Order items array
items.item_id int Yes Order item ID
items.quantity int Yes Items quantity

Description of Server Response keys:

Key Type Description
result array List of order IDs
package_number string Unique package number

Order shipping for FBS. When shipping an order, you should state all item_id present in it, dividing them between individual packages if necessary.

HTTP Request example:

POST /v1/order/ship/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_id": 123456,
  "packages": [
    {
      "items": [
        {
          "item_id": 123,
          "quantity": 1
        }
      ]
    }
  ]
}

Server Response example:

{
  "result": {
    "package_numbers": [
      "232123"
    ]
  }
}

Create a package and mark it as dispatched.

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID
packages array Yes Array with physical packages, each containing items
packages.items array Yes Array with items info and quantity within a package
packages.items.item_id int Yes Order item ID
packages.items.quantity int Yes Items quantity

Description of Server Response keys:

Key Type Description
result array List of order IDs
package_numbers string array Array with unique package numbers

Package label for FBS

HTTP Request example:

POST /v1/order/package-label/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_ids": [
    35536499
  ]
}

Server Response example:

{
  "result": {
    "content_type": "application/pdf",
    "base64_content": "dGVzdF9zdHJpbmc="
  }
}

Returns an FBS package label for one or several orders

Description of HTTP Request keys:

Key Type Required Description
order_ids int array Yes Order ID

Description of Server Response keys:

Key Type Description
result array List of order IDs
content_type string Content-Type of returned file
base64_content string File encoded in base64 string

Bill of Lading for FBS

Cancel items for CB

HTTP Request example:

POST /v1/order/items/cancel/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_id": 123456,
  "reason_code": 2,
  "item_ids": [
    123,
    456
  ]
}

Server Response example:

{
  "result": "success"
}

Will cancel an item in the order, requires cancellation reason to be provided. To receive the list of cancellation reasons use the Cancellation reasons method

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID
reason_code int Yes Cancellation reason code
item_ids int array Yes List of unique item IDs in the order

Description of Server Response keys:

Key Type Description
result string Result status

Cancel order for FBS

HTTP Request example:

POST /v1/order/cancel/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{
  "order_id": 2563636,
  "cancel_reason_id": 2
}

Server Response example:

{
  "result": "success"
}

Will cancel an order, requires cancellation reason to be provided. To receive the list of cancellation reasons use the Cancellation reasons method

Description of HTTP Request keys:

Key Type Required Description
order_id int Yes Order ID
cancel_reason_id int Yes Cancellation reason code

Description of Server Response keys:

Key Type Description
result string Result status

Cancellation reasons

HTTP Request example:

POST /v1/order/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 466
Api-Key: 9753260e-2324-fde7-97f1-7848ed7ed097
Content-Type: application/json

{}

Server Response example:

{
  "result": [
    {
      "id": 352,
      "title": "Product is out of stock"
    },
    {
      "id": 353,
      "title": "Product with wrong price"
    },
    {
      "id": 358,
      "title": "Canceled by seller"
    }
  ]
}

Receive the list of cancellation reasons ID and description.

Description of Server Response keys:

Key Type Description
result array List of order IDs
id int Shipping company (provider) ID
title string Shipping company name

Changelog

v2 (2019-11-12)

Features

v1.1.1 (2019-03-19):

Features

v1.1.0 (2019-01-22):

Features

v1.0.9 (2019-01-09):

Features

v1.0.8 (2018-12-19):

Features

v1.0.7 (2018-12-05):

Features

v1.0.6 (2018-11-28):

Features

v1.0.5 (2018-11-21):

Features

v1.0.4 (2018-11-06):

Features

v1.0.3 (2018-10-30)

Features

Bugs

v1.0.2 (2018-10-22)

Bugs

Features

v1.0.1 (2018-10-05)

Features