RetailCRM REST API

API

GET /api/api-versions Getting the list of available api versions

Getting the list of available api versions

Method allows to get all API-versions, which can be used on current account

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`versions`	`array`	Available API versions

GET /api/credentials Getting the list of available api methods and stores for current key

Getting the list of available api methods and stores for current key

Method allows to get list of methods and information about access to stores for current API-key.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`credentials[]`	`array of strings`	`deprecated` Available API methods
`scopes[]`	`array of strings`	Permissions allowed for the key
`siteAccess`	`string`	Stores access mode. Possible values: `access_full` - access to all stores; `access_selective` - access to a particular store. Available stores are listed at field `sitesAvailable`
`sitesAvailable[]`	`array of strings`	Available stores

Customers

GET /api/v3/customers Getting the list of customers matched the specified filter

Getting the list of customers matched the specified filter

To access the method, the following permission is required customer_read.

The result is returned page by page. In the field pagination there is information on pagination.

In the filter[manager], filter[source], filter[medium], filter[campaign] the internal ID of the system element is specified.

In the filter[managerGroup] filter the symbol code of the element is specified.

The filter filter[discountCardNumber] is available, if the field "Discount card" in the "Loyalty" module is active.

In the following filters filter[ids][] and filter[externalIds][] the array of internal and external identifiers are passed.

Filter filter[classSegment] allows to get segments of customers RFM-analysis. There are available the following values: monetary[0..2]_recency[0..2]frequency[0..2]_recency[0..2]monetary[0..2]_frequency[0..2].

By filter filter[name] possible to search by customer name and phone.

With the help of the filter[customFields][] filter you can search by the custom fields value. For the "Data book" fields the symbol code of data book value is specified. For the "Date" fields the date is specified in the Y-m-d format. For other field types exactly the value is specified.

For the Integer, Numeric and Date custom fields the filtration is realized over the range, for other fields types — by the exact value. Filter name by range is formed from the prefix minCustom/maxCustom and field symbol code in the format CamelCase, for other field types — from the prefix custom and field symbol code in the format CamelCase. E.g.: for the Date field with the symbol code birth_date there are filters filter[customFields][minCustomBirthDate] and filter[customFields][maxCustomBirthDate]. For the DataBook field with the symbol code quality there is filter filter[customFields][customQuality].

The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the "Loyalty" module settings.

Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields OGRNIP, certificateNumber, certificateDate are unavailable, for type entrepreneur the fields OGRN, KPP are unavailable.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100], [20\|50\|100\|250]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (CustomerFilterData)`
`filter[ids][]`	`array of integers`		Array of customers ID
`filter[externalIds][]`	`array of strings`		Array of customers externalID
`filter[name]`	`string`	`{length: {max: 255}}`	Customer
`filter[discountCardNumber]`	`string`	`{length: {max: 255}}`	Discount card number
`filter[ordersCount]`	`string`
`filter[averageSumm]`	`string`
`filter[totalSumm]`	`string`
`filter[costSumm]`	`string`
`filter[createdAt]`	`string`
`filter[firstOrder]`	`string`
`filter[lastOrder]`	`string`
`filter[city]`	`string`	`{length: {max: 255}}`	City
`filter[region]`	`string`	`{length: {max: 255}}`	Region
`filter[attachments]`	`integer`	`[1\|2\|3]`	Attachments
`filter[tasksCounts]`	`integer`	`[1\|2\|3]`	Tasks
`filter[classSegment]`	`string`	`{match: /^(monetary\|recency\|frequency)[0-2]_(recency\|frequency\|monetary)[0-2]$/}`	Segment
`filter[sex]`	`string`	`[female\|female_with_presumable\|male\|male_with_presumable]`	Sex
`filter[email]`	`string`	`{length: {max: 255}}`	E-mail
`filter[browserId]`	`string`		Device ID in Collector
`filter[contragentName]`	`string`	`{length: {max: 255}}`	Full name
`filter[contragentInn]`	`string`	`{match: /\d+/}`	VAT
`filter[contragentKpp]`	`string`	`{match: /\d+/}`	IEC
`filter[contragentBik]`	`string`	`{match: /\d+/}`	BIC
`filter[contragentCorrAccount]`	`string`	`{match: /\d+/}`	Corresponding account
`filter[contragentBankAccount]`	`string`	`{match: /\d+/}`	Bank account
`filter[contragentTypes][]`	`array of strings`	`{choice of [enterpreneur\|individual\|legal-entity]}`	Contractor types
`filter[sourceName]`	`string`	`{length: {max: 255}}`	Source
`filter[mediumName]`	`string`	`{length: {max: 255}}`	Medium
`filter[campaignName]`	`string`	`{length: {max: 255}}`	Campaign
`filter[firstWebVisit]`	`string`
`filter[lastWebVisit]`	`string`
`filter[countries][]`	`array of strings`		Countries
`filter[lastManagerCommunicatedAt]`	`string`
`filter[tags][]`	`array of strings`		Tags
`filter[attachedTags][]`	`array of strings`		List of attached tags (or)
`filter[subscriptions][]`	`array of objects (CustomerFilterCustomerSubscriptionData)`		Filter by user subscriptions
`filter[subscriptions][][channel]`	`string`		Subscription category channel
`filter[subscriptions][][subscription]`	`string`		Subscription category code
`filter[subscriptions][][subscribed]`	`boolean`		Is user subscribed
`filter[customFields]`	`array`		Custom fields
`filter[sites][]`	`array of strings`		Stores
`filter[managers][]`	`array of integers`		Managers
`filter[managerGroups][]`	`array of strings`		Manager groups
`filter[notes]`	`string`		Notes
`filter[vip]`	`boolean`		VIP customer
`filter[bad]`	`boolean`		BAD customer
`filter[minOrdersCount]`	`integer`		Orders count (from)
`filter[maxOrdersCount]`	`integer`		Orders count (to)
`filter[minAverageSumm]`	`integer`		Average items per cart (from)
`filter[maxAverageSumm]`	`integer`		Average items per cart (to)
`filter[minTotalSumm]`	`integer`		Total sum (from)
`filter[maxTotalSumm]`	`integer`		Total sum (to)
`filter[minCostSumm]`	`integer`		Amount of costs (from)
`filter[maxCostSumm]`	`integer`		Amount of costs (to)
`filter[dateFrom]`	`DateTime`	`Y-m-d`	Registration date (from)
`filter[dateTo]`	`DateTime`	`Y-m-d`	Registration date (to)
`filter[firstOrderFrom]`	`DateTime`	`Y-m-d`	First order (from)
`filter[firstOrderTo]`	`DateTime`	`Y-m-d`	First order (to)
`filter[lastOrderFrom]`	`DateTime`	`Y-m-d`	First order (from)
`filter[lastOrderTo]`	`DateTime`	`Y-m-d`	Last order (to)
`filter[isContact]`	`boolean`		The customer is a contact person
`filter[online]`	`boolean`		Customer is online
`filter[segment]`	`string`		Segment
`filter[commentary]`	`string`		Operator comment
`filter[mgChannels][]`	`array of integers`		Chat channels
`filter[keywordName]`	`string`		Keyword
`filter[adContentName]`	`string`		Ad content
`filter[abandonedCart]`	`boolean`
`filter[emailMarketingUnsubscribed]`	`boolean`		`deprecated` Unsubscribed from emails
`filter[mgCustomerId]`	`string`		MessageGateway Customer ID
`filter[firstWebVisitFrom]`	`DateTime`	`Y-m-d`	First visit (from)
`filter[firstWebVisitTo]`	`DateTime`	`Y-m-d`	First visit (to)
`filter[lastWebVisitFrom]`	`DateTime`	`Y-m-d`	Last visit (from)
`filter[lastWebVisitTo]`	`DateTime`	`Y-m-d`	Last visit (to)
`filter[contragentType]`	`string`		Contractor type
`filter[manager]`	`string`		Manager
`filter[source]`	`string`		Source
`filter[medium]`	`string`		Medium
`filter[campaign]`	`string`		Campaign
`filter[managerGroup]`	`string`		Manager group

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`customers[]`	`array of objects (Customer)`	Customer
`customers[][id]`	`integer`	Customer ID
`customers[][externalId]`	`string`	Customer external ID
`customers[][createdAt]`	`DateTime`	Created at
`customers[][managerId]`	`integer`	Customer manager
`customers[][vip]`	`boolean`	VIP customer
`customers[][bad]`	`boolean`	Bad customer
`customers[][site]`	`string`	Store, from which the customer came
`customers[][firstClientId]`	`string`	First Google Analytics clientId
`customers[][lastClientId]`	`string`	Last Google Analytics clientId
`customers[][customFields]`	`array`	Associative array of custom fields
`customers[][personalDiscount]`	`double`	Personal discount
`customers[][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customers[][discountCardNumber]`	`string`	Discount card number
`customers[][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)
`customers[][marginSumm]`	`float`	LTV (in base currency)
`customers[][totalSumm]`	`float`	Orders total sum (in base currency)
`customers[][averageSumm]`	`float`	Order average sum (in base currency)
`customers[][ordersCount]`	`integer`	Orders quantity
`customers[][address]`	`object (CustomerAddress)`	Customer address
`customers[][address][id]`	`integer`	Address ID
`customers[][address][index]`	`string`	Postal code
`customers[][address][countryIso]`	`string`	Country ISO code
`customers[][address][region]`	`string`	Region
`customers[][address][regionId]`	`integer`	Region ID in Geohelper
`customers[][address][city]`	`string`	City
`customers[][address][cityId]`	`integer`	City ID in Geohelper
`customers[][address][cityType]`	`string`	Locality type
`customers[][address][street]`	`string`	Street
`customers[][address][streetId]`	`integer`	Street ID in Geohelper
`customers[][address][streetType]`	`string`	Street type
`customers[][address][building]`	`string`	Building
`customers[][address][flat]`	`string`	Flat/office
`customers[][address][floor]`	`integer`	Floor
`customers[][address][block]`	`integer`	Entrance
`customers[][address][house]`	`string`	House
`customers[][address][housing]`	`string`	Housing
`customers[][address][metro]`	`string`	Underground
`customers[][address][notes]`	`string`	Notes to address
`customers[][address][text]`	`string`	Address as string
`customers[][maturationTime]`	`integer`	Maturation time, in seconds
`customers[][firstName]`	`string`	Name
`customers[][lastName]`	`string`	Surname
`customers[][patronymic]`	`string`	Middle name
`customers[][email]`	`string`	E-mail
`customers[][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customers[][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`customers[][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`customers[][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`customers[][customerSubscriptions][][subscription][channel]`	`string`	Channel
`customers[][customerSubscriptions][][subscription][name]`	`string`	Name
`customers[][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`customers[][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`customers[][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`customers[][customerSubscriptions][][subscription][ordering]`	`integer`
`customers[][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`customers[][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`customers[][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customers[][phones][][number]`	`string`	Phone number
`customers[][birthday]`	`DateTime`	Birthday
`customers[][source]`	`object (SerializedSource)`	Customer source
`customers[][source][source]`	`string`	Source
`customers[][source][medium]`	`string`	Medium
`customers[][source][campaign]`	`string`	Campaign
`customers[][source][keyword]`	`string`	Keyword
`customers[][source][content]`	`string`	Ad content
`customers[][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`customers[][mgCustomers][][id]`	`integer`	Customer ID
`customers[][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`customers[][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`customers[][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`customers[][commentary]`	`string`	`deprecated` Comment
`customers[][contragentType]`	`string`	Contragent type
`customers[][legalName]`	`string`	Legal name
`customers[][legalAddress]`	`string`	Registration address
`customers[][INN]`	`string`	TIN
`customers[][OKPO]`	`string`	RNNBO
`customers[][KPP]`	`string`	IECC
`customers[][OGRN]`	`string`	PSRN
`customers[][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customers[][certificateNumber]`	`string`	Certificate number
`customers[][certificateDate]`	`DateTime`	Certificate date
`customers[][BIK]`	`string`	RCBIC
`customers[][bank]`	`string`	Bank
`customers[][bankAddress]`	`string`	Bank address
`customers[][corrAccount]`	`string`	Corresponding account
`customers[][bankAccount]`	`string`	Settlement account

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/customers/create Customer creation

Customer creation

To access the method, the following permission is required customer_write.

Method creates the customer and returns internal ID of created customer.

If customer[createdAt] is not specified, then current time will be used as the date/time of customer creation.

The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings.

You can pass the custom fields value array in the field customer[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified.

The customer address customer[address] you can specify either in a string form in the customer[address][text] field or in a detailed view, filled all the fields except customer[address][text].

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store
`customer`	`object (SerializedCustomer)`
`customer[externalId]`	`string`	Customer external ID
`customer[createdAt]`	`DateTime`	Created at
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[discountCardNumber]`	`string`	Discount card number
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[commentary]`	`string`	`deprecated` Comment
`customer[contragentType]`	`string`	Contragent type
`customer[legalName]`	`string`	Legal name
`customer[legalAddress]`	`string`	Registration address
`customer[INN]`	`string`	TIN
`customer[OKPO]`	`string`	RNNBO
`customer[KPP]`	`string`	IECC
`customer[OGRN]`	`string`	PSRN
`customer[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[certificateNumber]`	`string`	Certificate number
`customer[certificateDate]`	`DateTime`	Certificate date
`customer[BIK]`	`string`	RCBIC
`customer[bank]`	`string`	Bank
`customer[bankAddress]`	`string`	Bank address
`customer[corrAccount]`	`string`	Corresponding account
`customer[bankAccount]`	`string`	Settlement account
`customer[managerId]`	`integer`	Customer manager
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Internal ID of created customer

HTTP statuses

Status code	Description
`201`	The customer is created
`400`	Error on customer creation

POST /api/v3/customers/fix-external-ids The mass recording of customers external ID

The mass recording of customers external ID

To access the method, the following permission is required customer_write.

This method is useful in case of reverse synchronization of customers, which were created in system initially.

The store requests customers created in system, and creates them in its own base. When creating of customers in store there are customers' own ID generated (externalId of customers in system notation). Immediately after customers creation the web-store calls method /api/v*/customers/fix-external-ids, keeping in system customers' own ID.

Parameters

Parameter	Type	Format	Description
`customers[]`	`array of objects (FixExternalRow)`		Uploaded objects IDs
`customers[][id]`	`integer`	`{not blank}{range: {>=1, <=2147483647}}}`	Internal ID
`customers[][externalId]`	`string`	`{not blank}`	External ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/customers/upload Packet customers uploading

Packet customers uploading

To access the method, the following permission is required customer_write.

Method allows to upload as packet up to 50 customers.

More detailed information on data format you can find in description of method /api/v*/customers/create.

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store, which includes downloadable customers
`customers[]`	`array of objects (SerializedCustomer)`
`customers[][externalId]`	`string`	Customer external ID
`customers[][createdAt]`	`DateTime`	Created at
`customers[][vip]`	`boolean`	VIP customer
`customers[][bad]`	`boolean`	Bad customer
`customers[][customFields]`	`array`	Associative array of custom fields
`customers[][personalDiscount]`	`double`	Personal discount
`customers[][discountCardNumber]`	`string`	Discount card number
`customers[][address]`	`object (CustomerAddress)`	Customer address
`customers[][address][index]`	`string`	Postal code
`customers[][address][countryIso]`	`string`	Country ISO code
`customers[][address][region]`	`string`	Region
`customers[][address][regionId]`	`integer`	Region ID in Geohelper
`customers[][address][city]`	`string`	City
`customers[][address][cityId]`	`integer`	City ID in Geohelper
`customers[][address][cityType]`	`string`	Locality type
`customers[][address][street]`	`string`	Street
`customers[][address][streetId]`	`integer`	Street ID in Geohelper
`customers[][address][streetType]`	`string`	Street type
`customers[][address][building]`	`string`	Building
`customers[][address][flat]`	`string`	Flat/office
`customers[][address][floor]`	`integer`	Floor
`customers[][address][block]`	`integer`	Entrance
`customers[][address][house]`	`string`	House
`customers[][address][housing]`	`string`	Housing
`customers[][address][metro]`	`string`	Underground
`customers[][address][notes]`	`string`	Notes to address
`customers[][address][text]`	`string`	Address as string
`customers[][firstName]`	`string`	Name
`customers[][lastName]`	`string`	Surname
`customers[][patronymic]`	`string`	Middle name
`customers[][email]`	`string`	E-mail
`customers[][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customers[][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customers[][phones][][number]`	`string`	Phone number
`customers[][birthday]`	`DateTime`	Birthday
`customers[][commentary]`	`string`	`deprecated` Comment
`customers[][contragentType]`	`string`	Contragent type
`customers[][legalName]`	`string`	Legal name
`customers[][legalAddress]`	`string`	Registration address
`customers[][INN]`	`string`	TIN
`customers[][OKPO]`	`string`	RNNBO
`customers[][KPP]`	`string`	IECC
`customers[][OGRN]`	`string`	PSRN
`customers[][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customers[][certificateNumber]`	`string`	Certificate number
`customers[][certificateDate]`	`DateTime`	Certificate date
`customers[][BIK]`	`string`	RCBIC
`customers[][bank]`	`string`	Bank
`customers[][bankAddress]`	`string`	Bank address
`customers[][corrAccount]`	`string`	Corresponding account
`customers[][bankAccount]`	`string`	Settlement account
`customers[][managerId]`	`integer`	Customer manager
`customers[][source]`	`object (SerializedSource)`	Customer source
`customers[][source][source]`	`string`	Source
`customers[][source][medium]`	`string`	Medium
`customers[][source][campaign]`	`string`	Campaign
`customers[][source][keyword]`	`string`	Keyword
`customers[][source][content]`	`string`	Ad content
`customers[][browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`uploadedCustomers[]`	`array of objects (FixExternalRow)`	Uploaded objects IDs
`uploadedCustomers[][id]`	`integer`	Internal ID
`uploadedCustomers[][externalId]`	`string`	External ID
`failedCustomers[]`	`array of objects (EntityWithExternalId)`	Non-uploaded objects IDs
`failedCustomers[][externalId]`	`string`	External ID (if available)

HTTP statuses

Status code	Description
`201`	All customers were successfully uploaded
`400`	Array of customers is not transmitted, or the array is too large
`460`	During uploading the errors occurred. The part of customers is not loaded (the response also contains an "errors" array)

GET /api/v3/customers/{externalId} Getting information on customer

Getting information on customer

To access the method, the following permission is required customer_read.

Method returns full information on the customer. You may refer to customer either by external customer ID (by=externalId), or by internal ID (by=id).

Empty fields without values are not returned.

In the managerId field the internal ID of system entity is returned.

The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the "Loyalty" module settings.

In the customFields field the value array of custom fields is returned. For the "DataBook" fields the symbol code of data book value is specified. For the date fields the date in the format Y-m-d is specified. For other field types the exact value is specified.

If the customer address was specified in the string form it will be returned to the customer[address][text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the customer[address][text] there will be automatically generated textual representation of the address.

Parameters

Parameter	Type	Format	Description
`externalId`	`string`		Customer ID

Filter parameters

Parameter Description

by

Template	`id\|externalId`
Default value	`externalId`
Description	Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId.

site

Description

Symbolic code of store

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`customer`	`object (Customer)`	Customer
`customer[id]`	`integer`	Customer ID
`customer[externalId]`	`string`	Customer external ID
`customer[createdAt]`	`DateTime`	Created at
`customer[managerId]`	`integer`	Customer manager
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[site]`	`string`	Store, from which the customer came
`customer[firstClientId]`	`string`	First Google Analytics clientId
`customer[lastClientId]`	`string`	Last Google Analytics clientId
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customer[discountCardNumber]`	`string`	Discount card number
`customer[avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)
`customer[marginSumm]`	`float`	LTV (in base currency)
`customer[totalSumm]`	`float`	Orders total sum (in base currency)
`customer[averageSumm]`	`float`	Order average sum (in base currency)
`customer[ordersCount]`	`integer`	Orders quantity
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][id]`	`integer`	Address ID
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[maturationTime]`	`integer`	Maturation time, in seconds
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`customer[customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`customer[customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`customer[customerSubscriptions][][subscription][channel]`	`string`	Channel
`customer[customerSubscriptions][][subscription][name]`	`string`	Name
`customer[customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`customer[customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`customer[customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`customer[customerSubscriptions][][subscription][ordering]`	`integer`
`customer[customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`customer[customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`customer[mgCustomers][][id]`	`integer`	Customer ID
`customer[mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`customer[mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`customer[mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`customer[commentary]`	`string`	`deprecated` Comment
`customer[contragentType]`	`string`	Contragent type
`customer[legalName]`	`string`	Legal name
`customer[legalAddress]`	`string`	Registration address
`customer[INN]`	`string`	TIN
`customer[OKPO]`	`string`	RNNBO
`customer[KPP]`	`string`	IECC
`customer[OGRN]`	`string`	PSRN
`customer[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[certificateNumber]`	`string`	Certificate number
`customer[certificateDate]`	`DateTime`	Certificate date
`customer[BIK]`	`string`	RCBIC
`customer[bank]`	`string`	Bank
`customer[bankAddress]`	`string`	Bank address
`customer[corrAccount]`	`string`	Corresponding account
`customer[bankAccount]`	`string`	Settlement account

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Customer not found (if the customer was deleted as a result of a merge, the data of the target customer will be in the "combinedTo" field)

POST /api/v3/customers/{externalId}/edit Customer editing

Customer editing

To access the method, the following permission is required customer_write.

Method allows to edit the customer. You may refer to customer either by external customer ID (by=externalId), or by internal ID (by=id).

In case of trying to edit the removed customer, the system returns state=removed in the answer.

The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings.

The customer address customer[address] you can specify either in a string form in the customer[address][text] field or in a detailed view, filled all the fields except customer[address][text].

Parameters

Parameter	Type	Description
`by`	`string`	Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId.
`site`	`string`	Symbolic code of store
`customer`	`object (SerializedCustomer)`
`customer[externalId]`	`string`	Customer external ID
`customer[createdAt]`	`DateTime`	Created at
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[discountCardNumber]`	`string`	Discount card number
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[commentary]`	`string`	`deprecated` Comment
`customer[contragentType]`	`string`	Contragent type
`customer[legalName]`	`string`	Legal name
`customer[legalAddress]`	`string`	Registration address
`customer[INN]`	`string`	TIN
`customer[OKPO]`	`string`	RNNBO
`customer[KPP]`	`string`	IECC
`customer[OGRN]`	`string`	PSRN
`customer[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[certificateNumber]`	`string`	Certificate number
`customer[certificateDate]`	`DateTime`	Certificate date
`customer[BIK]`	`string`	RCBIC
`customer[bank]`	`string`	Bank
`customer[bankAddress]`	`string`	Bank address
`customer[corrAccount]`	`string`	Corresponding account
`customer[bankAccount]`	`string`	Settlement account
`customer[managerId]`	`integer`	Customer manager
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Customer internal ID
`state`	`string`	Customer customer (not returned by default)

HTTP statuses

Status code	Description
`200`	The customer was successfully changed
`400`	Error on customer editing

Orders

GET /api/v3/orders Getting the list of orders matched the specified filter

Getting the list of orders matched the specified filter

To access the method, the following permission is required order_read.

The result is returned page by page. In the field pagination there is information on pagination.

In the filters filter[manager], filter[courier], filter[source], filter[medium], filter[campaign] the internal ID of the system element is specified.

In the filters filter[orderType], filter[paymentStatus], filter[paymentType], filter[deliveryType], filter[orderMethod], filter[managerGroup] the symbol code of the element is specified.

In the filter filter[numbers] the exact comparison with the specified array of strings is carried out.

In the following filters filter[ids][] and filter[externalIds][] the array of internal and external identifiers are passed.

In the filter filter[extendedStatus][] you can specify one or more statuses or order status groups. For filtration by status the symbol code of status is passed. For filtration by the status group the symbol code of status group and the postfix -group are passed. E.g.: filter[extendedStatus][]=new&filter[extendedStatus][]=approval-group.

Empty fields without values are not returned.

In the fields orderType, orderMethod, paymentType, paymentStatus, status, site, delivery[code] the symbol code of the element is returned.

In the fields managerId, sourceId the internal ID of the system entity is returned.

If the customer address was specified in the string form it will be returned to the delivery[address][text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the delivery[address][text] there will be automatically generated textual representation of the address.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100], [20\|50\|100\|250]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (OrderFilterData)`
`filter[ids][]`	`array of integers`		Array of order's ID
`filter[externalIds][]`	`array of strings`		Array of order's externalID
`filter[numbers][]`	`array of strings`		Array of order's number (no more than 100 numbers in one request)
`filter[customerId]`	`integer`	`{range: {>=0, <=100000000000}}`	Customer ID
`filter[customerExternalId]`	`string`	`{length: {max: 255}}`	Customer external ID
`filter[customer]`	`string`	`{length: {max: 255}}`	Customer (Name or phone number)
`filter[customerType]`	`string`	`[customer\|customer_corporate]`	Customer type
`filter[email]`	`string`	`{length: {max: 255}}`	E-mail
`filter[managers][]`	`array of integers`		Managers
`filter[managerGroups][]`	`array of strings`		Manager groups
`filter[paymentStatuses][]`	`array of strings`		Payment statuses
`filter[orderTypes][]`	`array of strings`		Order types
`filter[orderMethods][]`	`array of strings`		Order channels
`filter[product]`	`string`	`{length: {max: 255}}`	Product (title or article)
`filter[productSearchType]`	`string`
`filter[extendedStatus][]`	`array of strings`		Order status
`filter[statusComment]`	`string`	`{length: {max: 255}}`
`filter[sites][]`	`array of strings`		Stores
`filter[vip]`	`boolean`		VIP customer
`filter[bad]`	`boolean`		BAD customer
`filter[expired]`	`boolean`		Order expired
`filter[call]`	`boolean`		Call required
`filter[online]`	`boolean`		Customer is online
`filter[paymentTypes][]`	`array of strings`		Payment types
`filter[deliveryStates][]`	`array of strings`	`{choice of [cancel\|cancel_force\|error\|none\|processing\|success]}`	Statuses of delivery registration
`filter[deliveryTypes][]`	`array of strings`		Delivery types
`filter[deliveryServices][]`	`array of strings`		Services
`filter[countries][]`	`array of strings`		Countries
`filter[region]`	`string`	`{length: {max: 255}}`	Region
`filter[city]`	`string`	`{length: {max: 255}}`	City
`filter[index]`	`string`		Postal code
`filter[metro]`	`string`	`{length: {max: 255}}`	Subway
`filter[sourceName]`	`string`	`{length: {max: 255}}`	Source
`filter[mediumName]`	`string`	`{length: {max: 255}}`	Medium
`filter[campaignName]`	`string`	`{length: {max: 255}}`	Campaign
`filter[keywordName]`	`string`		Keyword
`filter[adContentName]`	`string`		Ad content
`filter[managerComment]`	`string`	`{length: {max: 255}}`	Manager comment
`filter[customerComment]`	`string`	`{length: {max: 255}}`	Customer comment
`filter[trackNumber]`	`string`	`{length: {max: 255}}`	Delivery tracking number
`filter[deliveryExternalId]`	`string`		Delivery ID
`filter[couriers][]`	`array of integers`		Couriers
`filter[contragentName]`	`string`	`{length: {max: 255}}`	Full name
`filter[contragentTypes][]`	`array of strings`	`{choice of [enterpreneur\|individual\|legal-entity]}`	Contractor types
`filter[contragentInn]`	`string`	`{match: /\d+/}`	VAT
`filter[contragentKpp]`	`string`	`{match: /\d+/}`	IEC
`filter[contragentBik]`	`string`	`{match: /\d+/}`	BIC
`filter[contragentCorrAccount]`	`string`	`{match: /\d+/}`	Corresponding account
`filter[contragentBankAccount]`	`string`	`{match: /\d+/}`	Bank account
`filter[companyName]`	`string`	`{length: {max: 255}}`	Company (name)
`filter[deliveryAddressNotes]`	`string`	`{length: {max: 255}}`	Notes to delivery address
`filter[productGroups][]`	`array of integers`
`filter[shipmentStores][]`	`array of strings`		Shipment warehouses
`filter[shipped]`	`boolean`		Shipped
`filter[attachments]`	`integer`	`[1\|2\|3]`	Attachments
`filter[receiptFiscalDocumentAttribute]`	`string`	`{length: {max: 255}}`	Fiscal Document Attribute
`filter[receiptStatus]`	`string`	`[done\|fail\|wait]`	Fiscalization status
`filter[receiptOperation]`	`string`	`[sell\|sell_refund]`	Fiscalization operation
`filter[receiptOrderStatus]`	`string`	`[done\|fail\|wait]`	Full fiscalization status
`filter[mgChannels][]`	`array of integers`		Chat channels
`filter[tasksCounts]`	`integer`	`[1\|2\|3]`	Tasks
`filter[tags][]`	`array of strings`
`filter[attachedTags][]`	`array of strings`
`filter[createdAtFrom]`	`DateTime`	`Y-m-d`	Order creation date (from)
`filter[createdAtTo]`	`DateTime`	`Y-m-d`	Order creation date (to)
`filter[fullPaidAtFrom]`	`DateTime`	`Y-m-d`	Full payment date (from)
`filter[fullPaidAtTo]`	`DateTime`	`Y-m-d`	Full payment date (to)
`filter[deliveryDateFrom]`	`DateTime`	`Y-m-d`	Delivery date (from)
`filter[deliveryDateTo]`	`DateTime`	`Y-m-d`	Delivery date (to)
`filter[statusUpdatedAtFrom]`	`DateTime`	`Y-m-d`	Last status changing date (from)
`filter[statusUpdatedAtTo]`	`DateTime`	`Y-m-d`	Last status changing date (to)
`filter[shipmentDateFrom]`	`DateTime`	`Y-m-d`	Shipment date (from)
`filter[shipmentDateTo]`	`DateTime`	`Y-m-d`	Shipment date (to)
`filter[firstWebVisitFrom]`	`DateTime`	`Y-m-d`	First visit (from)
`filter[firstWebVisitTo]`	`DateTime`	`Y-m-d`	First visit (to)
`filter[lastWebVisitFrom]`	`DateTime`	`Y-m-d`	Last visit (from)
`filter[lastWebVisitTo]`	`DateTime`	`Y-m-d`	Last visit (to)
`filter[firstOrderFrom]`	`DateTime`	`Y-m-d`	First order (from)
`filter[firstOrderTo]`	`DateTime`	`Y-m-d`	First order (to)
`filter[lastOrderFrom]`	`DateTime`	`Y-m-d`	Last order (from)
`filter[lastOrderTo]`	`DateTime`	`Y-m-d`	Last order (to)
`filter[paidAtFrom]`	`DateTime`	`Y-m-d`	Payment date (from)
`filter[paidAtTo]`	`DateTime`	`Y-m-d`	Payment date (to)
`filter[deliveryTimeFrom]`	`DateTime`	`HH:MM:SS`	Delivery time (from)
`filter[deliveryTimeTo]`	`DateTime`	`HH:MM:SS`	Delivery time (to)
`filter[minPrice]`	`integer`		Order price (from)
`filter[maxPrice]`	`integer`		Order price (to)
`filter[minCostSumm]`	`integer`		Amount of costs (from)
`filter[maxCostSumm]`	`integer`		Amount of costs (to)
`filter[minPrepaySumm]`	`integer`		Paid (from)
`filter[maxPrepaySumm]`	`integer`		Paid (to)
`filter[minDeliveryCost]`	`integer`		Delivery cost (from)
`filter[maxDeliveryCost]`	`integer`		Delivery cost (to)
`filter[minDeliveryNetCost]`	`integer`		Delivery net cost (from)
`filter[maxDeliveryNetCost]`	`integer`		Delivery net cost (to)
`filter[minMarginSumm]`	`integer`		Gross order profit (from)
`filter[maxMarginSumm]`	`integer`		Gross order profit (to)
`filter[minPurchaseSumm]`	`integer`		Order purchase price (from)
`filter[maxPurchaseSumm]`	`integer`		Order purchase price (to)
`filter[customFields]`	`array`		Filter by custom fields

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`orders[]`	`array of objects (Order)`	Order
`orders[][paymentType]`	`string`	`deprecated` Payment type
`orders[][paymentStatus]`	`string`	`deprecated` Payment status
`orders[][slug]`	`custom handler result for (int)`	`deprecated` Symbolic code
`orders[][discount]`	`float`	Monetary discount
`orders[][discountPercent]`	`float`	Percentage discount
`orders[][paymentDetail]`	`string`	`deprecated` Payment details
`orders[][currency]`	`string`	Currency
`orders[][id]`	`integer`	Order ID
`orders[][number]`	`string`	Order number
`orders[][externalId]`	`string`	Order external ID
`orders[][orderType]`	`string`	Order type
`orders[][orderMethod]`	`string`	Method
`orders[][countryIso]`	`string`	Country ISO code
`orders[][createdAt]`	`DateTime`	Order creation date
`orders[][statusUpdatedAt]`	`DateTime`	Date of the last order status change
`orders[][totalSumm]`	`double`	Total sum with discount (in entity currency)
`orders[][prepaySum]`	`double`	Paid sum (in entity currency)
`orders[][purchaseSumm]`	`double`	Total purchase sum (in base currency)
`orders[][mark]`	`integer`	Order evaluation
`orders[][markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`orders[][lastName]`	`string`	Surname
`orders[][firstName]`	`string`	Name
`orders[][patronymic]`	`string`	Middle name
`orders[][phone]`	`string`	Phone number
`orders[][additionalPhone]`	`string`	Additional phone
`orders[][email]`	`string`	E-mail
`orders[][call]`	`boolean`	Call required
`orders[][expired]`	`boolean`	Expired
`orders[][customerComment]`	`string`	Customer comment
`orders[][managerComment]`	`string`	Operator comment
`orders[][managerId]`	`integer`	Manager, responsible for order
`orders[][customer]`		CustomerCorporate customer
`orders[][customer][id]`	`integer`	Customer IDCorporate customer ID
`orders[][customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`orders[][customer][createdAt]`	`DateTime`	Created atCreated at
`orders[][customer][managerId]`	`integer`	Customer managerCorporate customer manager
`orders[][customer][vip]`	`boolean`	VIP customerVIP corporate customer
`orders[][customer][bad]`	`boolean`	Bad customerBad corporate customer
`orders[][customer][site]`	`string`	Store, from which the customer cameStore, from which the corporate customer came
`orders[][customer][firstClientId]`	`string`	First Google Analytics clientIdFirst Google Analytics unique clientId
`orders[][customer][lastClientId]`	`string`	Last Google Analytics clientIdLast Google Analytics unique clientId
`orders[][customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`orders[][customer][personalDiscount]`	`double`	Personal discountPersonal discount
`orders[][customer][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`orders[][customer][discountCardNumber]`	`string`	Discount card numberDiscount card number
`orders[][customer][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)Average gross profit of corporate customer orders (in base currency)
`orders[][customer][marginSumm]`	`float`	LTV (in base currency)LTV (in base currency)
`orders[][customer][totalSumm]`	`float`	Orders total sum (in base currency)Orders total sum (in base currency)
`orders[][customer][averageSumm]`	`float`	Order average sum (in base currency)Order average sum (in base currency)
`orders[][customer][ordersCount]`	`integer`	Orders quantityOrders quantity
`orders[][customer][address]`	`object (CustomerAddress)`	Customer address
`orders[][customer][address][id]`	`integer`	Address ID
`orders[][customer][address][index]`	`string`	Postal code
`orders[][customer][address][countryIso]`	`string`	Country ISO code
`orders[][customer][address][region]`	`string`	Region
`orders[][customer][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][customer][address][city]`	`string`	City
`orders[][customer][address][cityId]`	`integer`	City ID in Geohelper
`orders[][customer][address][cityType]`	`string`	Locality type
`orders[][customer][address][street]`	`string`	Street
`orders[][customer][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][customer][address][streetType]`	`string`	Street type
`orders[][customer][address][building]`	`string`	Building
`orders[][customer][address][flat]`	`string`	Flat/office
`orders[][customer][address][floor]`	`integer`	Floor
`orders[][customer][address][block]`	`integer`	Entrance
`orders[][customer][address][house]`	`string`	House
`orders[][customer][address][housing]`	`string`	Housing
`orders[][customer][address][metro]`	`string`	Underground
`orders[][customer][address][notes]`	`string`	Notes to address
`orders[][customer][address][text]`	`string`	Address as string
`orders[][customer][maturationTime]`	`integer`	Maturation time, in seconds
`orders[][customer][firstName]`	`string`	Name
`orders[][customer][lastName]`	`string`	Surname
`orders[][customer][patronymic]`	`string`	Middle name
`orders[][customer][email]`	`string`	E-mail
`orders[][customer][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`orders[][customer][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`orders[][customer][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`orders[][customer][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`orders[][customer][customerSubscriptions][][subscription][channel]`	`string`	Channel
`orders[][customer][customerSubscriptions][][subscription][name]`	`string`	Name
`orders[][customer][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`orders[][customer][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`orders[][customer][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`orders[][customer][customerSubscriptions][][subscription][ordering]`	`integer`
`orders[][customer][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`orders[][customer][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`orders[][customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`orders[][customer][phones][][number]`	`string`	Phone number
`orders[][customer][birthday]`	`DateTime`	Birthday
`orders[][customer][source]`	`object (SerializedSource)`	Customer source
`orders[][customer][source][source]`	`string`	Source
`orders[][customer][source][medium]`	`string`	Medium
`orders[][customer][source][campaign]`	`string`	Campaign
`orders[][customer][source][keyword]`	`string`	Keyword
`orders[][customer][source][content]`	`string`	Ad content
`orders[][customer][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`orders[][customer][mgCustomers][][id]`	`integer`	Customer ID
`orders[][customer][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`orders[][customer][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`orders[][customer][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`orders[][customer][commentary]`	`string`	`deprecated` Comment
`orders[][customer][contragentType]`	`string`	Contragent type
`orders[][customer][legalName]`	`string`	Legal name
`orders[][customer][legalAddress]`	`string`	Registration address
`orders[][customer][INN]`	`string`	TIN
`orders[][customer][OKPO]`	`string`	RNNBO
`orders[][customer][KPP]`	`string`	IECC
`orders[][customer][OGRN]`	`string`	PSRN
`orders[][customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][customer][certificateNumber]`	`string`	Certificate number
`orders[][customer][certificateDate]`	`DateTime`	Certificate date
`orders[][customer][BIK]`	`string`	RCBIC
`orders[][customer][bank]`	`string`	Bank
`orders[][customer][bankAddress]`	`string`	Bank address
`orders[][customer][corrAccount]`	`string`	Corresponding account
`orders[][customer][bankAccount]`	`string`	Settlement account
`orders[][customer][nickName]`	`string`	Name
`orders[][contragentType]`	`string`	Contragent type
`orders[][legalName]`	`string`	Legal name
`orders[][legalAddress]`	`string`	Registration address
`orders[][INN]`	`string`	TIN
`orders[][OKPO]`	`string`	RNNBO
`orders[][KPP]`	`string`	IECC
`orders[][OGRN]`	`string`	PSRN
`orders[][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][certificateNumber]`	`string`	Certificate number
`orders[][certificateDate]`	`DateTime`	Certificate date
`orders[][BIK]`	`string`	RCBIC
`orders[][bank]`	`string`	Bank
`orders[][bankAddress]`	`string`	Bank address
`orders[][corrAccount]`	`string`	Corresponding account
`orders[][bankAccount]`	`string`	Settlement account
`orders[][delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`orders[][delivery][code]`	`string`	Delivery type code
`orders[][delivery][integrationCode]`	`string`	Integration code of delivery type
`orders[][delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`orders[][delivery][data][externalId]`	`string`	Delivery id in delivery service`deprecated` Track number (Use `trackNumber` instead)
`orders[][delivery][data][trackNumber]`	`string`	Track number (`deprecated` for write)Track numberTrack numberTrack number
`orders[][delivery][data][status]`	`string`	Delivery status codeDelivery status codeDelivery status codeDelivery status code
`orders[][delivery][data][locked]`	`boolean`	Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`orders[][delivery][data][pickuppointAddress]`	`string`	Pickup point address
`orders[][delivery][data][days]`	`string`	Approximate delivery timeApproximate delivery timeApproximate delivery time
`orders[][delivery][data][statusText]`	`string`	Delivery status nameDelivery status nameDelivery status name
`orders[][delivery][data][statusDate]`	`DateTime`	Delivery status dateDate of the last delivery status updating
`orders[][delivery][data][tariff]`	`string`	Tariff code
`orders[][delivery][data][tariffName]`	`string`	Tariff name
`orders[][delivery][data][pickuppointId]`	`string`	Pickup point IDPickup point idPickup point ID
`orders[][delivery][data][pickuppointSchedule]`	`string`	Pickup point working timeSchedule of pickup point
`orders[][delivery][data][pickuppointPhone]`	`string`	Pickup point phone
`orders[][delivery][data][payerType]`	`string`	PayerPayer type
`orders[][delivery][data][statusComment]`	`string`	Comment to delivery status
`orders[][delivery][data][cost]`	`float`	Delivery cost received from delivery service (in entity currency)Delivery cost received from delivery service (in entity currency)
`orders[][delivery][data][minTerm]`	`integer`	Minimum delivery term
`orders[][delivery][data][maxTerm]`	`integer`	Maximum delivery term
`orders[][delivery][data][shipmentpointId]`	`string`	Shipment terminal IDShipment point id
`orders[][delivery][data][shipmentpointName]`	`string`	Shipment terminal name
`orders[][delivery][data][shipmentpointAddress]`	`string`	Shipment terminal address
`orders[][delivery][data][shipmentpointSchedule]`	`string`	Pickup point working time shipment terminal
`orders[][delivery][data][shipmentpointPhone]`	`string`	Shipment terminal phone
`orders[][delivery][data][shipmentpointCoordinateLatitude]`	`string`	Shipment terminal coordinates, latitude
`orders[][delivery][data][shipmentpointCoordinateLongitude]`	`string`	Shipment terminal coordinates, longitude
`orders[][delivery][data][pickuppointName]`	`string`	Pickup point name
`orders[][delivery][data][pickuppointCoordinateLatitude]`	`string`	Pickup point coordinates, latitude
`orders[][delivery][data][pickuppointCoordinateLongitude]`	`string`	Pickup point coordinates, longitude
`orders[][delivery][data][extraData]`	`array`	Additional delivery data (`deliveryDataField.code => value`)
`orders[][delivery][data][id]`	`integer`	Courier ID
`orders[][delivery][data][firstName]`	`string`	First name
`orders[][delivery][data][email]`	`string`	E-mail
`orders[][delivery][data][phone]`	`object (CourierPhone)`	Courier phone
`orders[][delivery][data][phone][number]`	`string`	Phone number
`orders[][delivery][data][courierId]`	`integer`	Courier ID
`orders[][delivery][data][statusCode]`	`string`	`deprecated` Delivery status code
`orders[][delivery][data][serviceType]`	`string`	Delivery technology
`orders[][delivery][data][pickuppoint]`	`string`	Pickup pointPickup point name
`orders[][delivery][data][statusName]`	`string`	Delivery status name
`orders[][delivery][data][price]`	`float`	Delivery cost received from delivery service
`orders[][delivery][data][receiverCity]`	`string`	Delivery city nameDelivery city
`orders[][delivery][data][receiverCityRef]`	`string`	Delivery city ID in NewPostDelivery city ID
`orders[][delivery][data][receiverStreet]`	`string`	Delivery street name
`orders[][delivery][data][receiverStreetRef]`	`string`	Delivery street ID in NewPost
`orders[][delivery][data][seatsAmount]`	`integer`	Quantity of sending seats
`orders[][delivery][data][cargoDescription]`	`string`	Cargo description
`orders[][delivery][data][paymentForm]`	`string`	Payment form
`orders[][delivery][data][packageNumber]`	`string`	Package number
`orders[][delivery][data][deliveryDate]`	`string`	Date when the recipient took the order
`orders[][delivery][data][denieReason]`	`string`	Rejection reason
`orders[][delivery][data][declaredValue]`	`float`	Declared value (in entity currency)
`orders[][delivery][data][sendDate]`	`DateTime`	Date of sending
`orders[][delivery][data][deliveryType]`	`string`	Delivery method ID
`orders[][delivery][data][deliveryName]`	`string`	Delivery service name
`orders[][delivery][data][pickupType]`	`integer`	Pickup type
`orders[][delivery][data][pickuppointDescription]`	`string`	Description of pickup point
`orders[][delivery][data][placesCount]`	`integer`	Seats quantity
`orders[][delivery][data][services][]`	`array of strings`	Additional services of delivery
`orders[][delivery][data][comment]`	`string`	Comment to the order
`orders[][delivery][service]`	`object (SerializedDeliveryService)`
`orders[][delivery][service][name]`	`string`	Name
`orders[][delivery][service][code]`	`string`	Symbolic code
`orders[][delivery][cost]`	`double`	Cost
`orders[][delivery][netCost]`	`double`	Delivery net cost
`orders[][delivery][date]`	`DateTime`	Delivery date
`orders[][delivery][address]`	`object (OrderDeliveryAddress)`	Address
`orders[][delivery][address][index]`	`string`	Postal code
`orders[][delivery][address][countryIso]`	`string`	Country ISO code
`orders[][delivery][address][region]`	`string`	Region
`orders[][delivery][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][delivery][address][city]`	`string`	City
`orders[][delivery][address][cityId]`	`integer`	City ID in Geohelper
`orders[][delivery][address][cityType]`	`string`	Locality type
`orders[][delivery][address][street]`	`string`	Street
`orders[][delivery][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][delivery][address][streetType]`	`string`	Street type
`orders[][delivery][address][building]`	`string`	Building
`orders[][delivery][address][flat]`	`string`	Flat/office
`orders[][delivery][address][floor]`	`integer`	Floor
`orders[][delivery][address][block]`	`integer`	Entrance
`orders[][delivery][address][house]`	`string`	House
`orders[][delivery][address][housing]`	`string`	Housing
`orders[][delivery][address][metro]`	`string`	Underground
`orders[][delivery][address][notes]`	`string`	Notes to address
`orders[][delivery][address][text]`	`string`	Address as string
`orders[][delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`orders[][site]`	`string`	Store
`orders[][status]`	`string`	Order status
`orders[][statusComment]`	`string`	Comment to the last status change
`orders[][source]`	`object (SerializedSource)`	Order source
`orders[][source][source]`	`string`	Source
`orders[][source][medium]`	`string`	Medium
`orders[][source][campaign]`	`string`	Campaign
`orders[][source][keyword]`	`string`	Keyword
`orders[][source][content]`	`string`	Ad content
`orders[][items][]`	`array of objects (OrderProduct)`	Order item
`orders[][items][][discount]`	`float`	`deprecated` Monetary discount per item
`orders[][items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`orders[][items][][markingCodes][]`	`array of strings`	Marking codes
`orders[][items][][id]`	`integer`	ID of order item
`orders[][items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`orders[][items][][prices][]`	`array of objects (OrderProductPriceItem)`	Set of total sales prices with the quantity
`orders[][items][][prices][][price]`	`float`	Total price including all discounts on the product and order (in entity currency)
`orders[][items][][prices][][quantity]`	`float`	Quantity of the product at the specified price
`orders[][items][][createdAt]`	`DateTime`	Date of order item creation in the system
`orders[][items][][quantity]`	`float`	Quantity
`orders[][items][][status]`	`string`	Status of the order item
`orders[][items][][comment]`	`string`	Comment to the order item
`orders[][items][][offer]`	`object (Offer)`	SKU
`orders[][items][][offer][externalId]`	`string`	SKU ID in store
`orders[][items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`orders[][items][][offer][name]`	`string`	Name
`orders[][items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`orders[][items][][properties][]`	`array`	[array] Additional properties of the order item
`orders[][items][][properties][][code]`	`string`	Property code (not mandatory field, the code can be transmitted in the property key)
`orders[][items][][properties][][name]`	`string`	Property name
`orders[][items][][properties][][value]`	`string`	Property value
`orders[][items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`orders[][items][][ordering]`	`integer`	Ordering
`orders[][fullPaidAt]`	`DateTime`	Full payment date
`orders[][fromApi]`	`boolean`	Order received through API
`orders[][shipmentStore]`	`string`	Shipping warehouse
`orders[][shipmentDate]`	`DateTime`	Shipment date
`orders[][shipped]`	`boolean`	Order is shipped
`orders[][customFields]`	`array`	Associative array of custom fields
`orders[][clientId]`	`string`	Google Analytics clientId

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/orders/create Order creation

Order creation

To access the method, the following permission is required order_write.

Method creates the order and returns internal ID of created order.

If order[createdAt] is not specified, then current time will be used as the date/time of order creation.

If you need to attach the order to the current customer, you should pass the customer external ID to the field order[customer][externalId], the customer internal ID to the field order[customer][id] or the customer ID in Daemon Collector in order[customer][browserId]. The search of the customer will be realized under the stores, to which the used API-key has an access. If the order[customer] is not specified, the customer will be created automatically based on the order data.

In the fields order[orderType], order[orderMethod], order[paymentType], order[paymentStatus], order[status], order[shipmentStore], order[delivery][code], order[items][][status] the symbol code of the element is specified.

In the fields order[managerId], order[sourceId] the internal ID of the system entity is specified.

The comment order[statusComment] cannot be changed without changing the order status order[status].

Order items are specified in the field order[items][]. The products that were not passed in the request for editing are deleted from the order. If item is in the catalog, then it is necessary to set the value for one of the following fields:

order[items][][offerId] – SKU ID;
order[items][][productId] – external ID of item or SKU;
order[items][][xmlId] – SKU ID in the warehouse system.

If the values are set for several fields, they will be processed in the following above order.

In case, if the ofeer will be not found by any of criteria, the order item will be automatically created based on data from fields order[items][][initialPrice], order[items][][purchasePrice], order[items][][productName].

The delivery address order[delivery][address] you can specify either in the string form in the order[delivery][address][text] field, or in the detailed view, filling all the fields except order[delivery][address][text].

In the order[customFields] field you can pass the values array of custom fields. For the "DataBook" fields the symbol code of data book value is specified. For the "Date" fields the date in the format Y-m-d is specified. For other field types the exact value is specified.

The order of order items order[items][] is saved in response.

Parameters

Parameter	Type	Format	Description
`site`	`string`		Symbolic code of store
`order`	`object (SerializedOrder)`
`order[paymentType]`	`string`		`deprecated` Payment type
`order[paymentStatus]`	`string`		`deprecated` Payment status
`order[paymentDetail]`	`string`		`deprecated` Payment details
`order[number]`	`string`		Order number
`order[externalId]`	`string`		Order external ID
`order[countryIso]`	`string`		Country ISO code
`order[createdAt]`	`DateTime`	`Y-m-d H:i:s`	Order creation date
`order[statusUpdatedAt]`	`DateTime`	`Y-m-d H:i:s`	Date of the last order status change
`order[mark]`	`integer`		Order evaluation
`order[markDatetime]`	`DateTime`	`Y-m-d H:i:s`	Date and time of getting evaluation from customer
`order[lastName]`	`string`		Surname
`order[firstName]`	`string`		Name
`order[patronymic]`	`string`		Middle name
`order[phone]`	`string`		Phone number
`order[additionalPhone]`	`string`		Additional phone
`order[email]`	`string`		E-mail
`order[call]`	`boolean`		Call required
`order[expired]`	`boolean`		Expired
`order[customerComment]`	`string`		Customer comment
`order[managerComment]`	`string`		Operator comment
`order[statusComment]`	`string`		Comment to the last status change
`order[shipmentDate]`	`DateTime`	`Y-m-d`	Shipment date
`order[shipped]`	`boolean`		Order is shipped
`order[contragentType]`	`string`		Contragent type
`order[legalName]`	`string`		Legal name
`order[legalAddress]`	`string`		Registration address
`order[INN]`	`string`		TIN
`order[OKPO]`	`string`		RNNBO
`order[KPP]`	`string`		IECC
`order[OGRN]`	`string`		PSRN
`order[OGRNIP]`	`string`		PSRN of Individual entrepreneur
`order[certificateNumber]`	`string`		Certificate number
`order[certificateDate]`	`DateTime`	`Y-m-d H:i:s`	Certificate date
`order[BIK]`	`string`		RCBIC
`order[bank]`	`string`		Bank
`order[bankAddress]`	`string`		Bank address
`order[corrAccount]`	`string`		Corresponding account
`order[bankAccount]`	`string`		Settlement account
`order[customFields]`	`array`		Associative array of custom fields
`order[orderType]`	`string`		Order type
`order[orderMethod]`	`string`		Method
`order[customerId]`	`string`		External ID of customer, who made orders (outdated)
`order[customer]`	`object (SerializedRelationCustomer)`		Customer
`order[customer][id]`	`integer`		Customer internal ID
`order[customer][externalId]`	`string`		Customer external ID
`order[customer][browserId]`	`string`		Device ID in Collector
`order[customer][site]`	`string`		Store code, required when externalId is specified
`order[managerId]`	`integer`		Manager, responsible for order
`order[status]`	`string`		Order status
`order[items][]`	`array of objects (SerializedOrderProduct)`
`order[items][][markingCodes][]`	`array of strings`		Marking codes
`order[items][][initialPrice]`	`double`		Item price/SKU (in entity currency)
`order[items][][createdAt]`	`DateTime`	`Y-m-d H:i:s`	Date of order item creation in the system
`order[items][][quantity]`	`float`		Quantity
`order[items][][comment]`	`string`		Comment to the order item
`order[items][][properties][]`	`array`		[array] Additional properties of the order item
`order[items][][properties][][code]`	`string`	`{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}}`	Property code (not mandatory field, the code can be transmitted in the property key)
`order[items][][properties][][name]`	`string`	`{not blank}`	Property name
`order[items][][properties][][value]`	`string`	`{not blank}`	Property value
`order[items][][purchasePrice]`	`double`		Purchasing price (in base currency)
`order[items][][ordering]`	`integer`		Ordering
`order[items][][offerId]`	`string`		`deprecated` SKU identifier in the system
`order[items][][productId]`	`string`		Identifier of item or SKU from external site
`order[items][][xmlId]`	`string`		SKU ID in the warehouse system
`order[items][][productName]`	`string`		Item name
`order[items][][status]`	`string`		Status of the order item
`order[items][][discount]`	`string`		`deprecated` Monetary discount per item
`order[items][][discountPercent]`	`string`		`deprecated` Percentage discount per item
`order[delivery]`	`object (SerializedOrderDelivery)`		Data on delivery
`order[delivery][code]`	`string`		Delivery type code
`order[delivery][data]`			Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`order[delivery][data][externalId]`	`string`		Delivery id in delivery service
`order[delivery][data][trackNumber]`	`string`		Track number (`deprecated` for write)Track numberTrack number
`order[delivery][data][locked]`	`boolean`		Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`order[delivery][data][tariff]`	`string`		Tariff code
`order[delivery][data][pickuppointId]`	`string`		Pickup point IDPickup point idPickup point ID
`order[delivery][data][payerType]`	`string`		PayerPayer type
`order[delivery][data][shipmentpointId]`	`string`		Shipment terminal IDShipment point id
`order[delivery][data][extraData]`	`array`		Additional delivery data (`deliveryDataField.code => value`)
`order[delivery][data][courierId]`	`integer`		Courier ID
`order[delivery][data][serviceType]`	`string`		Delivery technology
`order[delivery][data][pickuppoint]`	`string`		Pickup point
`order[delivery][data][receiverCity]`	`string`		Delivery city nameDelivery city
`order[delivery][data][receiverCityRef]`	`string`		Delivery city ID in NewPostDelivery city ID
`order[delivery][data][receiverStreet]`	`string`		Delivery street name
`order[delivery][data][receiverStreetRef]`	`string`		Delivery street ID in NewPost
`order[delivery][data][seatsAmount]`	`integer`		Quantity of sending seats
`order[delivery][data][cargoDescription]`	`string`		Cargo description
`order[delivery][data][paymentForm]`	`string`		Payment form
`order[delivery][data][packageNumber]`	`string`		Package number
`order[delivery][data][declaredValue]`	`float`		Declared value (in entity currency)
`order[delivery][data][sendDate]`	`DateTime`	`Y-m-d`	Date of sending
`order[delivery][data][deliveryType]`	`string`		Delivery method ID
`order[delivery][data][pickupType]`	`integer`		Pickup type
`order[delivery][data][placesCount]`	`integer`		Seats quantity
`order[delivery][data][services][]`	`array of strings`		Additional services of delivery
`order[delivery][data][comment]`	`string`		Comment to the order
`order[delivery][service]`	`object (SerializedDeliveryService)`
`order[delivery][service][name]`	`string`		Name
`order[delivery][service][code]`	`string`		Symbolic code
`order[delivery][service][deliveryType]`	`string`		Delivery type
`order[delivery][cost]`	`double`		Cost
`order[delivery][netCost]`	`double`		Delivery net cost
`order[delivery][date]`	`DateTime`	`Y-m-d`	Delivery date
`order[delivery][address]`	`object (OrderDeliveryAddress)`		Address
`order[delivery][address][index]`	`string`		Postal code
`order[delivery][address][countryIso]`	`string`		Country ISO code
`order[delivery][address][region]`	`string`		Region
`order[delivery][address][regionId]`	`integer`		Region ID in Geohelper
`order[delivery][address][city]`	`string`		City
`order[delivery][address][cityId]`	`integer`		City ID in Geohelper
`order[delivery][address][cityType]`	`string`		Locality type
`order[delivery][address][street]`	`string`		Street
`order[delivery][address][streetId]`	`integer`		Street ID in Geohelper
`order[delivery][address][streetType]`	`string`		Street type
`order[delivery][address][building]`	`string`		Building
`order[delivery][address][flat]`	`string`		Flat/office
`order[delivery][address][floor]`	`integer`		Floor
`order[delivery][address][block]`	`integer`		Entrance
`order[delivery][address][house]`	`string`		House
`order[delivery][address][housing]`	`string`		Housing
`order[delivery][address][metro]`	`string`		Underground
`order[delivery][address][notes]`	`string`		Notes to address
`order[delivery][address][text]`	`string`		Address as string
`order[delivery][address][deliveryTime]`	`string`		`deprecated` Delivery time
`order[source]`	`object (SerializedSource)`		Order source
`order[source][source]`	`string`		Source
`order[source][medium]`	`string`		Medium
`order[source][campaign]`	`string`		Campaign
`order[source][keyword]`	`string`		Keyword
`order[source][content]`	`string`		Ad content
`order[shipmentStore]`	`string`		Shipping warehouse
`order[discount]`	`string`		Monetary discount
`order[discountPercent]`	`string`		Percentage discount

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Internal ID of created order
`order`	`object (CreateOrder)`
`order[paymentType]`	`string`	`deprecated` Payment type
`order[paymentStatus]`	`string`	`deprecated` Payment status
`order[slug]`	`custom handler result for (int)`	`deprecated` Symbolic code
`order[discount]`	`float`	Monetary discount
`order[discountPercent]`	`float`	Percentage discount
`order[paymentDetail]`	`string`	`deprecated` Payment details
`order[currency]`	`string`	Currency
`order[id]`	`integer`	Order ID
`order[number]`	`string`	Order number
`order[externalId]`	`string`	Order external ID
`order[orderType]`	`string`	Order type
`order[orderMethod]`	`string`	Method
`order[countryIso]`	`string`	Country ISO code
`order[createdAt]`	`DateTime`	Order creation date
`order[statusUpdatedAt]`	`DateTime`	Date of the last order status change
`order[totalSumm]`	`double`	Total sum with discount (in entity currency)
`order[prepaySum]`	`double`	Paid sum (in entity currency)
`order[purchaseSumm]`	`double`	Total purchase sum (in base currency)
`order[mark]`	`integer`	Order evaluation
`order[markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`order[lastName]`	`string`	Surname
`order[firstName]`	`string`	Name
`order[patronymic]`	`string`	Middle name
`order[phone]`	`string`	Phone number
`order[additionalPhone]`	`string`	Additional phone
`order[email]`	`string`	E-mail
`order[call]`	`boolean`	Call required
`order[expired]`	`boolean`	Expired
`order[customerComment]`	`string`	Customer comment
`order[managerComment]`	`string`	Operator comment
`order[managerId]`	`integer`	Manager, responsible for order
`order[customer]`		CustomerCorporate customer
`order[customer][id]`	`integer`	Customer IDCorporate customer ID
`order[customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`order[customer][createdAt]`	`DateTime`	Created atCreated at
`order[customer][managerId]`	`integer`	Customer managerCorporate customer manager
`order[customer][vip]`	`boolean`	VIP customerVIP corporate customer
`order[customer][bad]`	`boolean`	Bad customerBad corporate customer
`order[customer][site]`	`string`	Store, from which the customer cameStore, from which the corporate customer came
`order[customer][firstClientId]`	`string`	First Google Analytics clientIdFirst Google Analytics unique clientId
`order[customer][lastClientId]`	`string`	Last Google Analytics clientIdLast Google Analytics unique clientId
`order[customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`order[customer][personalDiscount]`	`double`	Personal discountPersonal discount
`order[customer][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`order[customer][discountCardNumber]`	`string`	Discount card numberDiscount card number
`order[customer][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)Average gross profit of corporate customer orders (in base currency)
`order[customer][marginSumm]`	`float`	LTV (in base currency)LTV (in base currency)
`order[customer][totalSumm]`	`float`	Orders total sum (in base currency)Orders total sum (in base currency)
`order[customer][averageSumm]`	`float`	Order average sum (in base currency)Order average sum (in base currency)
`order[customer][ordersCount]`	`integer`	Orders quantityOrders quantity
`order[customer][address]`	`object (CustomerAddress)`	Customer address
`order[customer][address][id]`	`integer`	Address ID
`order[customer][address][index]`	`string`	Postal code
`order[customer][address][countryIso]`	`string`	Country ISO code
`order[customer][address][region]`	`string`	Region
`order[customer][address][regionId]`	`integer`	Region ID in Geohelper
`order[customer][address][city]`	`string`	City
`order[customer][address][cityId]`	`integer`	City ID in Geohelper
`order[customer][address][cityType]`	`string`	Locality type
`order[customer][address][street]`	`string`	Street
`order[customer][address][streetId]`	`integer`	Street ID in Geohelper
`order[customer][address][streetType]`	`string`	Street type
`order[customer][address][building]`	`string`	Building
`order[customer][address][flat]`	`string`	Flat/office
`order[customer][address][floor]`	`integer`	Floor
`order[customer][address][block]`	`integer`	Entrance
`order[customer][address][house]`	`string`	House
`order[customer][address][housing]`	`string`	Housing
`order[customer][address][metro]`	`string`	Underground
`order[customer][address][notes]`	`string`	Notes to address
`order[customer][address][text]`	`string`	Address as string
`order[customer][maturationTime]`	`integer`	Maturation time, in seconds
`order[customer][firstName]`	`string`	Name
`order[customer][lastName]`	`string`	Surname
`order[customer][patronymic]`	`string`	Middle name
`order[customer][email]`	`string`	E-mail
`order[customer][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`order[customer][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`order[customer][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`order[customer][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`order[customer][customerSubscriptions][][subscription][channel]`	`string`	Channel
`order[customer][customerSubscriptions][][subscription][name]`	`string`	Name
`order[customer][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`order[customer][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`order[customer][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`order[customer][customerSubscriptions][][subscription][ordering]`	`integer`
`order[customer][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`order[customer][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`order[customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`order[customer][phones][][number]`	`string`	Phone number
`order[customer][birthday]`	`DateTime`	Birthday
`order[customer][source]`	`object (SerializedSource)`	Customer source
`order[customer][source][source]`	`string`	Source
`order[customer][source][medium]`	`string`	Medium
`order[customer][source][campaign]`	`string`	Campaign
`order[customer][source][keyword]`	`string`	Keyword
`order[customer][source][content]`	`string`	Ad content
`order[customer][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`order[customer][mgCustomers][][id]`	`integer`	Customer ID
`order[customer][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`order[customer][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`order[customer][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`order[customer][commentary]`	`string`	`deprecated` Comment
`order[customer][contragentType]`	`string`	Contragent type
`order[customer][legalName]`	`string`	Legal name
`order[customer][legalAddress]`	`string`	Registration address
`order[customer][INN]`	`string`	TIN
`order[customer][OKPO]`	`string`	RNNBO
`order[customer][KPP]`	`string`	IECC
`order[customer][OGRN]`	`string`	PSRN
`order[customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[customer][certificateNumber]`	`string`	Certificate number
`order[customer][certificateDate]`	`DateTime`	Certificate date
`order[customer][BIK]`	`string`	RCBIC
`order[customer][bank]`	`string`	Bank
`order[customer][bankAddress]`	`string`	Bank address
`order[customer][corrAccount]`	`string`	Corresponding account
`order[customer][bankAccount]`	`string`	Settlement account
`order[customer][nickName]`	`string`	Name
`order[contragentType]`	`string`	Contragent type
`order[legalName]`	`string`	Legal name
`order[legalAddress]`	`string`	Registration address
`order[INN]`	`string`	TIN
`order[OKPO]`	`string`	RNNBO
`order[KPP]`	`string`	IECC
`order[OGRN]`	`string`	PSRN
`order[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[certificateNumber]`	`string`	Certificate number
`order[certificateDate]`	`DateTime`	Certificate date
`order[BIK]`	`string`	RCBIC
`order[bank]`	`string`	Bank
`order[bankAddress]`	`string`	Bank address
`order[corrAccount]`	`string`	Corresponding account
`order[bankAccount]`	`string`	Settlement account
`order[delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`order[delivery][code]`	`string`	Delivery type code
`order[delivery][integrationCode]`	`string`	Integration code of delivery type
`order[delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`order[delivery][data][externalId]`	`string`	Delivery id in delivery service`deprecated` Track number (Use `trackNumber` instead)
`order[delivery][data][trackNumber]`	`string`	Track number (`deprecated` for write)Track numberTrack numberTrack number
`order[delivery][data][status]`	`string`	Delivery status codeDelivery status codeDelivery status codeDelivery status code
`order[delivery][data][locked]`	`boolean`	Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`order[delivery][data][pickuppointAddress]`	`string`	Pickup point address
`order[delivery][data][days]`	`string`	Approximate delivery timeApproximate delivery timeApproximate delivery time
`order[delivery][data][statusText]`	`string`	Delivery status nameDelivery status nameDelivery status name
`order[delivery][data][statusDate]`	`DateTime`	Delivery status dateDate of the last delivery status updating
`order[delivery][data][tariff]`	`string`	Tariff code
`order[delivery][data][tariffName]`	`string`	Tariff name
`order[delivery][data][pickuppointId]`	`string`	Pickup point IDPickup point idPickup point ID
`order[delivery][data][pickuppointSchedule]`	`string`	Pickup point working timeSchedule of pickup point
`order[delivery][data][pickuppointPhone]`	`string`	Pickup point phone
`order[delivery][data][payerType]`	`string`	PayerPayer type
`order[delivery][data][statusComment]`	`string`	Comment to delivery status
`order[delivery][data][cost]`	`float`	Delivery cost received from delivery service (in entity currency)Delivery cost received from delivery service (in entity currency)
`order[delivery][data][minTerm]`	`integer`	Minimum delivery term
`order[delivery][data][maxTerm]`	`integer`	Maximum delivery term
`order[delivery][data][shipmentpointId]`	`string`	Shipment terminal IDShipment point id
`order[delivery][data][shipmentpointName]`	`string`	Shipment terminal name
`order[delivery][data][shipmentpointAddress]`	`string`	Shipment terminal address
`order[delivery][data][shipmentpointSchedule]`	`string`	Pickup point working time shipment terminal
`order[delivery][data][shipmentpointPhone]`	`string`	Shipment terminal phone
`order[delivery][data][shipmentpointCoordinateLatitude]`	`string`	Shipment terminal coordinates, latitude
`order[delivery][data][shipmentpointCoordinateLongitude]`	`string`	Shipment terminal coordinates, longitude
`order[delivery][data][pickuppointName]`	`string`	Pickup point name
`order[delivery][data][pickuppointCoordinateLatitude]`	`string`	Pickup point coordinates, latitude
`order[delivery][data][pickuppointCoordinateLongitude]`	`string`	Pickup point coordinates, longitude
`order[delivery][data][extraData]`	`array`	Additional delivery data (`deliveryDataField.code => value`)
`order[delivery][data][id]`	`integer`	Courier ID
`order[delivery][data][firstName]`	`string`	First name
`order[delivery][data][email]`	`string`	E-mail
`order[delivery][data][phone]`	`object (CourierPhone)`	Courier phone
`order[delivery][data][phone][number]`	`string`	Phone number
`order[delivery][data][courierId]`	`integer`	Courier ID
`order[delivery][data][statusCode]`	`string`	`deprecated` Delivery status code
`order[delivery][data][serviceType]`	`string`	Delivery technology
`order[delivery][data][pickuppoint]`	`string`	Pickup pointPickup point name
`order[delivery][data][statusName]`	`string`	Delivery status name
`order[delivery][data][price]`	`float`	Delivery cost received from delivery service
`order[delivery][data][receiverCity]`	`string`	Delivery city nameDelivery city
`order[delivery][data][receiverCityRef]`	`string`	Delivery city ID in NewPostDelivery city ID
`order[delivery][data][receiverStreet]`	`string`	Delivery street name
`order[delivery][data][receiverStreetRef]`	`string`	Delivery street ID in NewPost
`order[delivery][data][seatsAmount]`	`integer`	Quantity of sending seats
`order[delivery][data][cargoDescription]`	`string`	Cargo description
`order[delivery][data][paymentForm]`	`string`	Payment form
`order[delivery][data][packageNumber]`	`string`	Package number
`order[delivery][data][deliveryDate]`	`string`	Date when the recipient took the order
`order[delivery][data][denieReason]`	`string`	Rejection reason
`order[delivery][data][declaredValue]`	`float`	Declared value (in entity currency)
`order[delivery][data][sendDate]`	`DateTime`	Date of sending
`order[delivery][data][deliveryType]`	`string`	Delivery method ID
`order[delivery][data][deliveryName]`	`string`	Delivery service name
`order[delivery][data][pickupType]`	`integer`	Pickup type
`order[delivery][data][pickuppointDescription]`	`string`	Description of pickup point
`order[delivery][data][placesCount]`	`integer`	Seats quantity
`order[delivery][data][services][]`	`array of strings`	Additional services of delivery
`order[delivery][data][comment]`	`string`	Comment to the order
`order[delivery][service]`	`object (SerializedDeliveryService)`
`order[delivery][service][name]`	`string`	Name
`order[delivery][service][code]`	`string`	Symbolic code
`order[delivery][cost]`	`double`	Cost
`order[delivery][netCost]`	`double`	Delivery net cost
`order[delivery][date]`	`DateTime`	Delivery date
`order[delivery][address]`	`object (OrderDeliveryAddress)`	Address
`order[delivery][address][index]`	`string`	Postal code
`order[delivery][address][countryIso]`	`string`	Country ISO code
`order[delivery][address][region]`	`string`	Region
`order[delivery][address][regionId]`	`integer`	Region ID in Geohelper
`order[delivery][address][city]`	`string`	City
`order[delivery][address][cityId]`	`integer`	City ID in Geohelper
`order[delivery][address][cityType]`	`string`	Locality type
`order[delivery][address][street]`	`string`	Street
`order[delivery][address][streetId]`	`integer`	Street ID in Geohelper
`order[delivery][address][streetType]`	`string`	Street type
`order[delivery][address][building]`	`string`	Building
`order[delivery][address][flat]`	`string`	Flat/office
`order[delivery][address][floor]`	`integer`	Floor
`order[delivery][address][block]`	`integer`	Entrance
`order[delivery][address][house]`	`string`	House
`order[delivery][address][housing]`	`string`	Housing
`order[delivery][address][metro]`	`string`	Underground
`order[delivery][address][notes]`	`string`	Notes to address
`order[delivery][address][text]`	`string`	Address as string
`order[delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`order[site]`	`string`	Store
`order[status]`	`string`	Order status
`order[statusComment]`	`string`	Comment to the last status change
`order[source]`	`object (SerializedSource)`	Order source
`order[source][source]`	`string`	Source
`order[source][medium]`	`string`	Medium
`order[source][campaign]`	`string`	Campaign
`order[source][keyword]`	`string`	Keyword
`order[source][content]`	`string`	Ad content
`order[items][]`	`array of objects (OrderProduct)`	Order item
`order[items][][discount]`	`float`	`deprecated` Monetary discount per item
`order[items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`order[items][][markingCodes][]`	`array of strings`	Marking codes
`order[items][][id]`	`integer`	ID of order item
`order[items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`order[items][][prices][]`	`array of objects (OrderProductPriceItem)`	Set of total sales prices with the quantity
`order[items][][prices][][price]`	`float`	Total price including all discounts on the product and order (in entity currency)
`order[items][][prices][][quantity]`	`float`	Quantity of the product at the specified price
`order[items][][createdAt]`	`DateTime`	Date of order item creation in the system
`order[items][][quantity]`	`float`	Quantity
`order[items][][status]`	`string`	Status of the order item
`order[items][][comment]`	`string`	Comment to the order item
`order[items][][offer]`	`object (Offer)`	SKU
`order[items][][offer][externalId]`	`string`	SKU ID in store
`order[items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`order[items][][offer][name]`	`string`	Name
`order[items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`order[items][][properties]`	`array`	[array] Additional properties of the order item
`order[items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`order[items][][ordering]`	`integer`	Ordering
`order[fullPaidAt]`	`DateTime`	Full payment date
`order[fromApi]`	`boolean`	Order received through API
`order[shipmentStore]`	`string`	Shipping warehouse
`order[shipmentDate]`	`DateTime`	Shipment date
`order[shipped]`	`boolean`	Order is shipped
`order[customFields]`	`array`	Associative array of custom fields
`order[clientId]`	`string`	Google Analytics clientId

HTTP statuses

Status code	Description
`201`	The order is created
`400`	Error on order creation

POST /api/v3/orders/fix-external-ids The mass recording of orders external ID

The mass recording of orders external ID

To access the method, the following permission is required order_write.

This method is useful in case of reverse synchronization of orders, which were created in system initially.

It is recommended to use the following script of order reverse synchronization between web store and system. Web store periodically requests method /api/v*/orders/history. On the basis of received data the store applies changes to existing orders, and also creates new orders, created in system initially. When creating of orders in store there are orders' own ID generated (externalId of orders in system notation). Immediately after customers creation the web-store calls method /api/v*/orders/fix-external-ids, keeping in system orders' own ID.

Parameters

Parameter	Type	Format	Description
`orders[]`	`array of objects (FixExternalRow)`		Uploaded objects IDs
`orders[][id]`	`digit`	`{not blank}{range: {>=1, <=2147483647}}}`	Internal ID
`orders[][externalId]`	`string`	`{not blank}`	External ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v3/orders/history Getting the order change history

Getting the order change history

To access the method, the following permission is required order_read.

Returns order changes, which were carried out within the specified date range. If the filter by date is not specified, then limit of last changes with displacement offset is returned.

If specified the parameter skipMyChanges=true, then from the order changes set will be excluded orders, created through API with the help of current API-key.

In orders and order items there is specified the fact of their creation and removing through parameters created=true and deleted=true respectively. For orders with parameter created=true full information on the order, and also full information on customer, who made order, is returned.

Parameters

Parameter	Type	Format	Description
`startDate`	`DateTime`	`Y-m-d H:i:s`	Date/time of change (from)
`endDate`	`DateTime`	`Y-m-d H:i:s`	Date/time of change (to)
`limit`	`integer`	`{not blank}[50\|100\|200]}`	Quantity of changes in the response (200 by default)
`offset`	`integer`	`{not blank}{range: {>=0}}}`	Shift in the output (0 by default)
`skipMyChanges`	`boolean`		Do not include changes made through API with current API-key

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`generatedAt`	`DateTime`	Time of response formation
`orders[]`	`array of objects (SerializedOrder)`
`orders[][paymentType]`	`string`	`deprecated` Payment type
`orders[][paymentStatus]`	`string`	`deprecated` Payment status
`orders[][discount]`	`float`	Monetary discount
`orders[][discountPercent]`	`float`	Percentage discount
`orders[][paymentDetail]`	`string`	`deprecated` Payment details
`orders[][currency]`	`string`	Currency
`orders[][id]`	`integer`	Order ID
`orders[][number]`	`string`	Order number
`orders[][externalId]`	`string`	Order external ID
`orders[][orderType]`	`string`	Order type
`orders[][orderMethod]`	`string`	Method
`orders[][countryIso]`	`string`	Country ISO code
`orders[][createdAt]`	`DateTime`	Order creation date
`orders[][totalSumm]`	`double`	Total sum with discount (in entity currency)
`orders[][prepaySum]`	`double`	Paid sum (in entity currency)
`orders[][purchaseSumm]`	`double`	Total purchase sum (in base currency)
`orders[][mark]`	`integer`	Order evaluation
`orders[][markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`orders[][lastName]`	`string`	Surname
`orders[][firstName]`	`string`	Name
`orders[][patronymic]`	`string`	Middle name
`orders[][phone]`	`string`	Phone number
`orders[][additionalPhone]`	`string`	Additional phone
`orders[][email]`	`string`	E-mail
`orders[][call]`	`boolean`	Call required
`orders[][expired]`	`boolean`	Expired
`orders[][customerComment]`	`string`	Customer comment
`orders[][managerComment]`	`string`	Operator comment
`orders[][customer]`		CustomerCorporate customer
`orders[][customer][id]`	`integer`	Customer IDCorporate customer ID
`orders[][customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`orders[][customer][createdAt]`	`DateTime`	Created atCreated at
`orders[][customer][vip]`	`boolean`	VIP customerVIP corporate customer
`orders[][customer][bad]`	`boolean`	Bad customerBad corporate customer
`orders[][customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`orders[][customer][address]`	`object (CustomerAddress)`	Customer address
`orders[][customer][address][id]`	`integer`	Address ID
`orders[][customer][address][index]`	`string`	Postal code
`orders[][customer][address][countryIso]`	`string`	Country ISO code
`orders[][customer][address][region]`	`string`	Region
`orders[][customer][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][customer][address][city]`	`string`	City
`orders[][customer][address][cityId]`	`integer`	City ID in Geohelper
`orders[][customer][address][cityType]`	`string`	Locality type
`orders[][customer][address][street]`	`string`	Street
`orders[][customer][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][customer][address][streetType]`	`string`	Street type
`orders[][customer][address][building]`	`string`	Building
`orders[][customer][address][flat]`	`string`	Flat/office
`orders[][customer][address][floor]`	`integer`	Floor
`orders[][customer][address][block]`	`integer`	Entrance
`orders[][customer][address][house]`	`string`	House
`orders[][customer][address][housing]`	`string`	Housing
`orders[][customer][address][metro]`	`string`	Underground
`orders[][customer][address][notes]`	`string`	Notes to address
`orders[][customer][address][text]`	`string`	Address as string
`orders[][customer][firstName]`	`string`	Name
`orders[][customer][lastName]`	`string`	Surname
`orders[][customer][patronymic]`	`string`	Middle name
`orders[][customer][email]`	`string`	E-mail
`orders[][customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`orders[][customer][phones][][number]`	`string`	Phone number
`orders[][customer][birthday]`	`DateTime`	Birthday
`orders[][customer][commentary]`	`string`	`deprecated` Comment
`orders[][customer][contragentType]`	`string`	Contragent type
`orders[][customer][legalName]`	`string`	Legal name
`orders[][customer][legalAddress]`	`string`	Registration address
`orders[][customer][INN]`	`string`	TIN
`orders[][customer][OKPO]`	`string`	RNNBO
`orders[][customer][KPP]`	`string`	IECC
`orders[][customer][OGRN]`	`string`	PSRN
`orders[][customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][customer][certificateNumber]`	`string`	Certificate number
`orders[][customer][certificateDate]`	`DateTime`	Certificate date
`orders[][customer][BIK]`	`string`	RCBIC
`orders[][customer][bank]`	`string`	Bank
`orders[][customer][bankAddress]`	`string`	Bank address
`orders[][customer][corrAccount]`	`string`	Corresponding account
`orders[][customer][bankAccount]`	`string`	Settlement account
`orders[][customer][nickName]`	`string`	Name
`orders[][contragentType]`	`string`	Contragent type
`orders[][legalName]`	`string`	Legal name
`orders[][legalAddress]`	`string`	Registration address
`orders[][INN]`	`string`	TIN
`orders[][OKPO]`	`string`	RNNBO
`orders[][KPP]`	`string`	IECC
`orders[][OGRN]`	`string`	PSRN
`orders[][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][certificateNumber]`	`string`	Certificate number
`orders[][certificateDate]`	`DateTime`	Certificate date
`orders[][BIK]`	`string`	RCBIC
`orders[][bank]`	`string`	Bank
`orders[][bankAddress]`	`string`	Bank address
`orders[][corrAccount]`	`string`	Corresponding account
`orders[][bankAccount]`	`string`	Settlement account
`orders[][delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`orders[][delivery][code]`	`string`	Delivery type code
`orders[][delivery][integrationCode]`	`string`	Integration code of delivery type
`orders[][delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`orders[][delivery][service]`	`object (SerializedDeliveryService)`
`orders[][delivery][service][name]`	`string`	Name
`orders[][delivery][service][code]`	`string`	Symbolic code
`orders[][delivery][cost]`	`double`	Cost
`orders[][delivery][netCost]`	`double`	Delivery net cost
`orders[][delivery][date]`	`DateTime`	Delivery date
`orders[][delivery][address]`	`object (OrderDeliveryAddress)`	Address
`orders[][delivery][address][index]`	`string`	Postal code
`orders[][delivery][address][countryIso]`	`string`	Country ISO code
`orders[][delivery][address][region]`	`string`	Region
`orders[][delivery][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][delivery][address][city]`	`string`	City
`orders[][delivery][address][cityId]`	`integer`	City ID in Geohelper
`orders[][delivery][address][cityType]`	`string`	Locality type
`orders[][delivery][address][street]`	`string`	Street
`orders[][delivery][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][delivery][address][streetType]`	`string`	Street type
`orders[][delivery][address][building]`	`string`	Building
`orders[][delivery][address][flat]`	`string`	Flat/office
`orders[][delivery][address][floor]`	`integer`	Floor
`orders[][delivery][address][block]`	`integer`	Entrance
`orders[][delivery][address][house]`	`string`	House
`orders[][delivery][address][housing]`	`string`	Housing
`orders[][delivery][address][metro]`	`string`	Underground
`orders[][delivery][address][notes]`	`string`	Notes to address
`orders[][delivery][address][text]`	`string`	Address as string
`orders[][delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`orders[][site]`	`string`	Store
`orders[][status]`	`string`	Order status
`orders[][statusComment]`	`string`	Comment to the last status change
`orders[][items][]`	`array of objects (OrderProduct)`	Order item
`orders[][items][][discount]`	`float`	`deprecated` Monetary discount per item
`orders[][items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`orders[][items][][id]`	`integer`	ID of order item
`orders[][items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`orders[][items][][createdAt]`	`DateTime`	Date of order item creation in the system
`orders[][items][][quantity]`	`float`	Quantity
`orders[][items][][status]`	`string`	Status of the order item
`orders[][items][][comment]`	`string`	Comment to the order item
`orders[][items][][offer]`	`object (Offer)`	SKU
`orders[][items][][offer][externalId]`	`string`	SKU ID in store
`orders[][items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`orders[][items][][offer][name]`	`string`	Name
`orders[][items][][offer][properties][]`	`array of strings`	SKU properties
`orders[][items][][created]`	`boolean`	The order item is added to the order
`orders[][items][][deleted]`	`boolean`	The order item is deleted in the order
`orders[][items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`orders[][items][][properties][]`	`array`	[array] Additional properties of the order item
`orders[][items][][properties][][code]`	`string`	Property code (not mandatory field, the code can be transmitted in the property key)
`orders[][items][][properties][][name]`	`string`	Property name
`orders[][items][][properties][][value]`	`string`	Property value
`orders[][items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`orders[][fullPaidAt]`	`DateTime`	Full payment date
`orders[][fromApi]`	`boolean`	Order received through API
`orders[][shipmentStore]`	`string`	Shipping warehouse
`orders[][shipmentDate]`	`DateTime`	Shipment date
`orders[][shipped]`	`boolean`	Order is shipped
`orders[][customFields]`	`array`	Associative array of custom fields
`orders[][customerId]`	`string`	External ID of customer, who made orders (outdated)
`orders[][managerId]`	`integer`	Manager, responsible for order
`orders[][created]`	`boolean`	Order created
`orders[][deleted]`	`boolean`	Order deleted

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v3/orders/statuses Getting the list of order statuses

Getting the list of order statuses

To access the method, the following permission is required order_read.

Returns statuses (and status groups) of orders, id or externalId of which were specified in parameters of query ids[] and externalIds[].

You may specify summarily up to 500 ids. if specified both ids[], and externalIds[], then order searching is carried out by all specified ids.

Parameters

Parameter	Type	Format	Description
`ids[]`	`array`		Orders ID (internal identifiers)
`externalIds[]`	`array`		Orders externalId (external identifiers)

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`orders[]`	`array of objects (OrderStatusItem)`	Order statuses
`orders[][id]`	`integer`	Order ID
`orders[][externalId]`	`string`	Order external ID
`orders[][status]`	`string`	Order status
`orders[][group]`	`string`	Order status group
`orders[][number]`	`string`	Order number

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/orders/upload Packet orders uploading

Packet orders uploading

To access the method, the following permission is required order_write.

Method allows to upload as packet up to 50 orders.

More detailed information on data format you can find in description of method /api/v*/orders/create.

Parameters

Parameter	Type	Format	Description
`site`	`string`		Symbolic code of store, which includes downloadable orders
`orders[]`	`array of objects (SerializedOrder)`
`orders[][paymentType]`	`string`		`deprecated` Payment type
`orders[][paymentStatus]`	`string`		`deprecated` Payment status
`orders[][paymentDetail]`	`string`		`deprecated` Payment details
`orders[][number]`	`string`		Order number
`orders[][externalId]`	`string`		Order external ID
`orders[][countryIso]`	`string`		Country ISO code
`orders[][createdAt]`	`DateTime`	`Y-m-d H:i:s`	Order creation date
`orders[][statusUpdatedAt]`	`DateTime`	`Y-m-d H:i:s`	Date of the last order status change
`orders[][mark]`	`integer`		Order evaluation
`orders[][markDatetime]`	`DateTime`	`Y-m-d H:i:s`	Date and time of getting evaluation from customer
`orders[][lastName]`	`string`		Surname
`orders[][firstName]`	`string`		Name
`orders[][patronymic]`	`string`		Middle name
`orders[][phone]`	`string`		Phone number
`orders[][additionalPhone]`	`string`		Additional phone
`orders[][email]`	`string`		E-mail
`orders[][call]`	`boolean`		Call required
`orders[][expired]`	`boolean`		Expired
`orders[][customerComment]`	`string`		Customer comment
`orders[][managerComment]`	`string`		Operator comment
`orders[][statusComment]`	`string`		Comment to the last status change
`orders[][shipmentDate]`	`DateTime`	`Y-m-d`	Shipment date
`orders[][shipped]`	`boolean`		Order is shipped
`orders[][contragentType]`	`string`		Contragent type
`orders[][legalName]`	`string`		Legal name
`orders[][legalAddress]`	`string`		Registration address
`orders[][INN]`	`string`		TIN
`orders[][OKPO]`	`string`		RNNBO
`orders[][KPP]`	`string`		IECC
`orders[][OGRN]`	`string`		PSRN
`orders[][OGRNIP]`	`string`		PSRN of Individual entrepreneur
`orders[][certificateNumber]`	`string`		Certificate number
`orders[][certificateDate]`	`DateTime`	`Y-m-d H:i:s`	Certificate date
`orders[][BIK]`	`string`		RCBIC
`orders[][bank]`	`string`		Bank
`orders[][bankAddress]`	`string`		Bank address
`orders[][corrAccount]`	`string`		Corresponding account
`orders[][bankAccount]`	`string`		Settlement account
`orders[][customFields]`	`array`		Associative array of custom fields
`orders[][orderType]`	`string`		Order type
`orders[][orderMethod]`	`string`		Method
`orders[][customerId]`	`string`		External ID of customer, who made orders (outdated)
`orders[][customer]`	`object (SerializedRelationCustomer)`		Customer
`orders[][customer][id]`	`integer`		Customer internal ID
`orders[][customer][externalId]`	`string`		Customer external ID
`orders[][customer][browserId]`	`string`		Device ID in Collector
`orders[][customer][site]`	`string`		Store code, required when externalId is specified
`orders[][managerId]`	`integer`		Manager, responsible for order
`orders[][status]`	`string`		Order status
`orders[][items][]`	`array of objects (SerializedOrderProduct)`
`orders[][items][][markingCodes][]`	`array of strings`		Marking codes
`orders[][items][][initialPrice]`	`double`		Item price/SKU (in entity currency)
`orders[][items][][createdAt]`	`DateTime`	`Y-m-d H:i:s`	Date of order item creation in the system
`orders[][items][][quantity]`	`float`		Quantity
`orders[][items][][comment]`	`string`		Comment to the order item
`orders[][items][][properties][]`	`array`		[array] Additional properties of the order item
`orders[][items][][properties][][code]`	`string`	`{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}}`	Property code (not mandatory field, the code can be transmitted in the property key)
`orders[][items][][properties][][name]`	`string`	`{not blank}`	Property name
`orders[][items][][properties][][value]`	`string`	`{not blank}`	Property value
`orders[][items][][purchasePrice]`	`double`		Purchasing price (in base currency)
`orders[][items][][ordering]`	`integer`		Ordering
`orders[][items][][offerId]`	`string`		`deprecated` SKU identifier in the system
`orders[][items][][productId]`	`string`		Identifier of item or SKU from external site
`orders[][items][][xmlId]`	`string`		SKU ID in the warehouse system
`orders[][items][][productName]`	`string`		Item name
`orders[][items][][status]`	`string`		Status of the order item
`orders[][items][][discount]`	`string`		`deprecated` Monetary discount per item
`orders[][items][][discountPercent]`	`string`		`deprecated` Percentage discount per item
`orders[][delivery]`	`object (SerializedOrderDelivery)`		Data on delivery
`orders[][delivery][code]`	`string`		Delivery type code
`orders[][delivery][data]`			Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`orders[][delivery][data][externalId]`	`string`		Delivery id in delivery service
`orders[][delivery][data][trackNumber]`	`string`		Track number (`deprecated` for write)Track numberTrack number
`orders[][delivery][data][locked]`	`boolean`		Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`orders[][delivery][data][tariff]`	`string`		Tariff code
`orders[][delivery][data][pickuppointId]`	`string`		Pickup point IDPickup point idPickup point ID
`orders[][delivery][data][payerType]`	`string`		PayerPayer type
`orders[][delivery][data][shipmentpointId]`	`string`		Shipment terminal IDShipment point id
`orders[][delivery][data][extraData]`	`array`		Additional delivery data (`deliveryDataField.code => value`)
`orders[][delivery][data][courierId]`	`integer`		Courier ID
`orders[][delivery][data][serviceType]`	`string`		Delivery technology
`orders[][delivery][data][pickuppoint]`	`string`		Pickup point
`orders[][delivery][data][receiverCity]`	`string`		Delivery city nameDelivery city
`orders[][delivery][data][receiverCityRef]`	`string`		Delivery city ID in NewPostDelivery city ID
`orders[][delivery][data][receiverStreet]`	`string`		Delivery street name
`orders[][delivery][data][receiverStreetRef]`	`string`		Delivery street ID in NewPost
`orders[][delivery][data][seatsAmount]`	`integer`		Quantity of sending seats
`orders[][delivery][data][cargoDescription]`	`string`		Cargo description
`orders[][delivery][data][paymentForm]`	`string`		Payment form
`orders[][delivery][data][packageNumber]`	`string`		Package number
`orders[][delivery][data][declaredValue]`	`float`		Declared value (in entity currency)
`orders[][delivery][data][sendDate]`	`DateTime`	`Y-m-d`	Date of sending
`orders[][delivery][data][deliveryType]`	`string`		Delivery method ID
`orders[][delivery][data][pickupType]`	`integer`		Pickup type
`orders[][delivery][data][placesCount]`	`integer`		Seats quantity
`orders[][delivery][data][services][]`	`array of strings`		Additional services of delivery
`orders[][delivery][data][comment]`	`string`		Comment to the order
`orders[][delivery][service]`	`object (SerializedDeliveryService)`
`orders[][delivery][service][name]`	`string`		Name
`orders[][delivery][service][code]`	`string`		Symbolic code
`orders[][delivery][service][deliveryType]`	`string`		Delivery type
`orders[][delivery][cost]`	`double`		Cost
`orders[][delivery][netCost]`	`double`		Delivery net cost
`orders[][delivery][date]`	`DateTime`	`Y-m-d`	Delivery date
`orders[][delivery][address]`	`object (OrderDeliveryAddress)`		Address
`orders[][delivery][address][index]`	`string`		Postal code
`orders[][delivery][address][countryIso]`	`string`		Country ISO code
`orders[][delivery][address][region]`	`string`		Region
`orders[][delivery][address][regionId]`	`integer`		Region ID in Geohelper
`orders[][delivery][address][city]`	`string`		City
`orders[][delivery][address][cityId]`	`integer`		City ID in Geohelper
`orders[][delivery][address][cityType]`	`string`		Locality type
`orders[][delivery][address][street]`	`string`		Street
`orders[][delivery][address][streetId]`	`integer`		Street ID in Geohelper
`orders[][delivery][address][streetType]`	`string`		Street type
`orders[][delivery][address][building]`	`string`		Building
`orders[][delivery][address][flat]`	`string`		Flat/office
`orders[][delivery][address][floor]`	`integer`		Floor
`orders[][delivery][address][block]`	`integer`		Entrance
`orders[][delivery][address][house]`	`string`		House
`orders[][delivery][address][housing]`	`string`		Housing
`orders[][delivery][address][metro]`	`string`		Underground
`orders[][delivery][address][notes]`	`string`		Notes to address
`orders[][delivery][address][text]`	`string`		Address as string
`orders[][delivery][address][deliveryTime]`	`string`		`deprecated` Delivery time
`orders[][source]`	`object (SerializedSource)`		Order source
`orders[][source][source]`	`string`		Source
`orders[][source][medium]`	`string`		Medium
`orders[][source][campaign]`	`string`		Campaign
`orders[][source][keyword]`	`string`		Keyword
`orders[][source][content]`	`string`		Ad content
`orders[][shipmentStore]`	`string`		Shipping warehouse
`orders[][discount]`	`string`		Monetary discount
`orders[][discountPercent]`	`string`		Percentage discount

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`uploadedOrders[]`	`array of objects (FixExternalRow)`	Uploaded objects IDs
`uploadedOrders[][id]`	`integer`	Internal ID
`uploadedOrders[][externalId]`	`string`	External ID
`failedOrders[]`	`array of objects (EntityWithExternalId)`	Non-uploaded objects IDs
`failedOrders[][externalId]`	`string`	External ID (if available)
`orders[]`	`array of objects (Order)`	Order
`orders[][paymentType]`	`string`	`deprecated` Payment type
`orders[][paymentStatus]`	`string`	`deprecated` Payment status
`orders[][slug]`	`custom handler result for (int)`	`deprecated` Symbolic code
`orders[][discount]`	`float`	Monetary discount
`orders[][discountPercent]`	`float`	Percentage discount
`orders[][paymentDetail]`	`string`	`deprecated` Payment details
`orders[][currency]`	`string`	Currency
`orders[][id]`	`integer`	Order ID
`orders[][number]`	`string`	Order number
`orders[][externalId]`	`string`	Order external ID
`orders[][orderType]`	`string`	Order type
`orders[][orderMethod]`	`string`	Method
`orders[][countryIso]`	`string`	Country ISO code
`orders[][createdAt]`	`DateTime`	Order creation date
`orders[][statusUpdatedAt]`	`DateTime`	Date of the last order status change
`orders[][totalSumm]`	`double`	Total sum with discount (in entity currency)
`orders[][prepaySum]`	`double`	Paid sum (in entity currency)
`orders[][purchaseSumm]`	`double`	Total purchase sum (in base currency)
`orders[][mark]`	`integer`	Order evaluation
`orders[][markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`orders[][lastName]`	`string`	Surname
`orders[][firstName]`	`string`	Name
`orders[][patronymic]`	`string`	Middle name
`orders[][phone]`	`string`	Phone number
`orders[][additionalPhone]`	`string`	Additional phone
`orders[][email]`	`string`	E-mail
`orders[][call]`	`boolean`	Call required
`orders[][expired]`	`boolean`	Expired
`orders[][customerComment]`	`string`	Customer comment
`orders[][managerComment]`	`string`	Operator comment
`orders[][managerId]`	`integer`	Manager, responsible for order
`orders[][customer]`		CustomerCorporate customer
`orders[][customer][id]`	`integer`	Customer IDCorporate customer ID
`orders[][customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`orders[][customer][createdAt]`	`DateTime`	Created atCreated at
`orders[][customer][managerId]`	`integer`	Customer managerCorporate customer manager
`orders[][customer][vip]`	`boolean`	VIP customerVIP corporate customer
`orders[][customer][bad]`	`boolean`	Bad customerBad corporate customer
`orders[][customer][site]`	`string`	Store, from which the customer cameStore, from which the corporate customer came
`orders[][customer][firstClientId]`	`string`	First Google Analytics clientIdFirst Google Analytics unique clientId
`orders[][customer][lastClientId]`	`string`	Last Google Analytics clientIdLast Google Analytics unique clientId
`orders[][customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`orders[][customer][personalDiscount]`	`double`	Personal discountPersonal discount
`orders[][customer][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`orders[][customer][discountCardNumber]`	`string`	Discount card numberDiscount card number
`orders[][customer][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)Average gross profit of corporate customer orders (in base currency)
`orders[][customer][marginSumm]`	`float`	LTV (in base currency)LTV (in base currency)
`orders[][customer][totalSumm]`	`float`	Orders total sum (in base currency)Orders total sum (in base currency)
`orders[][customer][averageSumm]`	`float`	Order average sum (in base currency)Order average sum (in base currency)
`orders[][customer][ordersCount]`	`integer`	Orders quantityOrders quantity
`orders[][customer][address]`	`object (CustomerAddress)`	Customer address
`orders[][customer][address][id]`	`integer`	Address ID
`orders[][customer][address][index]`	`string`	Postal code
`orders[][customer][address][countryIso]`	`string`	Country ISO code
`orders[][customer][address][region]`	`string`	Region
`orders[][customer][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][customer][address][city]`	`string`	City
`orders[][customer][address][cityId]`	`integer`	City ID in Geohelper
`orders[][customer][address][cityType]`	`string`	Locality type
`orders[][customer][address][street]`	`string`	Street
`orders[][customer][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][customer][address][streetType]`	`string`	Street type
`orders[][customer][address][building]`	`string`	Building
`orders[][customer][address][flat]`	`string`	Flat/office
`orders[][customer][address][floor]`	`integer`	Floor
`orders[][customer][address][block]`	`integer`	Entrance
`orders[][customer][address][house]`	`string`	House
`orders[][customer][address][housing]`	`string`	Housing
`orders[][customer][address][metro]`	`string`	Underground
`orders[][customer][address][notes]`	`string`	Notes to address
`orders[][customer][address][text]`	`string`	Address as string
`orders[][customer][maturationTime]`	`integer`	Maturation time, in seconds
`orders[][customer][firstName]`	`string`	Name
`orders[][customer][lastName]`	`string`	Surname
`orders[][customer][patronymic]`	`string`	Middle name
`orders[][customer][email]`	`string`	E-mail
`orders[][customer][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`orders[][customer][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`orders[][customer][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`orders[][customer][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`orders[][customer][customerSubscriptions][][subscription][channel]`	`string`	Channel
`orders[][customer][customerSubscriptions][][subscription][name]`	`string`	Name
`orders[][customer][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`orders[][customer][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`orders[][customer][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`orders[][customer][customerSubscriptions][][subscription][ordering]`	`integer`
`orders[][customer][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`orders[][customer][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`orders[][customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`orders[][customer][phones][][number]`	`string`	Phone number
`orders[][customer][birthday]`	`DateTime`	Birthday
`orders[][customer][source]`	`object (SerializedSource)`	Customer source
`orders[][customer][source][source]`	`string`	Source
`orders[][customer][source][medium]`	`string`	Medium
`orders[][customer][source][campaign]`	`string`	Campaign
`orders[][customer][source][keyword]`	`string`	Keyword
`orders[][customer][source][content]`	`string`	Ad content
`orders[][customer][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`orders[][customer][mgCustomers][][id]`	`integer`	Customer ID
`orders[][customer][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`orders[][customer][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`orders[][customer][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`orders[][customer][commentary]`	`string`	`deprecated` Comment
`orders[][customer][contragentType]`	`string`	Contragent type
`orders[][customer][legalName]`	`string`	Legal name
`orders[][customer][legalAddress]`	`string`	Registration address
`orders[][customer][INN]`	`string`	TIN
`orders[][customer][OKPO]`	`string`	RNNBO
`orders[][customer][KPP]`	`string`	IECC
`orders[][customer][OGRN]`	`string`	PSRN
`orders[][customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][customer][certificateNumber]`	`string`	Certificate number
`orders[][customer][certificateDate]`	`DateTime`	Certificate date
`orders[][customer][BIK]`	`string`	RCBIC
`orders[][customer][bank]`	`string`	Bank
`orders[][customer][bankAddress]`	`string`	Bank address
`orders[][customer][corrAccount]`	`string`	Corresponding account
`orders[][customer][bankAccount]`	`string`	Settlement account
`orders[][customer][nickName]`	`string`	Name
`orders[][contragentType]`	`string`	Contragent type
`orders[][legalName]`	`string`	Legal name
`orders[][legalAddress]`	`string`	Registration address
`orders[][INN]`	`string`	TIN
`orders[][OKPO]`	`string`	RNNBO
`orders[][KPP]`	`string`	IECC
`orders[][OGRN]`	`string`	PSRN
`orders[][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`orders[][certificateNumber]`	`string`	Certificate number
`orders[][certificateDate]`	`DateTime`	Certificate date
`orders[][BIK]`	`string`	RCBIC
`orders[][bank]`	`string`	Bank
`orders[][bankAddress]`	`string`	Bank address
`orders[][corrAccount]`	`string`	Corresponding account
`orders[][bankAccount]`	`string`	Settlement account
`orders[][delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`orders[][delivery][code]`	`string`	Delivery type code
`orders[][delivery][integrationCode]`	`string`	Integration code of delivery type
`orders[][delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`orders[][delivery][data][externalId]`	`string`	Delivery id in delivery service`deprecated` Track number (Use `trackNumber` instead)
`orders[][delivery][data][trackNumber]`	`string`	Track number (`deprecated` for write)Track numberTrack numberTrack number
`orders[][delivery][data][status]`	`string`	Delivery status codeDelivery status codeDelivery status codeDelivery status code
`orders[][delivery][data][locked]`	`boolean`	Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`orders[][delivery][data][pickuppointAddress]`	`string`	Pickup point address
`orders[][delivery][data][days]`	`string`	Approximate delivery timeApproximate delivery timeApproximate delivery time
`orders[][delivery][data][statusText]`	`string`	Delivery status nameDelivery status nameDelivery status name
`orders[][delivery][data][statusDate]`	`DateTime`	Delivery status dateDate of the last delivery status updating
`orders[][delivery][data][tariff]`	`string`	Tariff code
`orders[][delivery][data][tariffName]`	`string`	Tariff name
`orders[][delivery][data][pickuppointId]`	`string`	Pickup point IDPickup point idPickup point ID
`orders[][delivery][data][pickuppointSchedule]`	`string`	Pickup point working timeSchedule of pickup point
`orders[][delivery][data][pickuppointPhone]`	`string`	Pickup point phone
`orders[][delivery][data][payerType]`	`string`	PayerPayer type
`orders[][delivery][data][statusComment]`	`string`	Comment to delivery status
`orders[][delivery][data][cost]`	`float`	Delivery cost received from delivery service (in entity currency)Delivery cost received from delivery service (in entity currency)
`orders[][delivery][data][minTerm]`	`integer`	Minimum delivery term
`orders[][delivery][data][maxTerm]`	`integer`	Maximum delivery term
`orders[][delivery][data][shipmentpointId]`	`string`	Shipment terminal IDShipment point id
`orders[][delivery][data][shipmentpointName]`	`string`	Shipment terminal name
`orders[][delivery][data][shipmentpointAddress]`	`string`	Shipment terminal address
`orders[][delivery][data][shipmentpointSchedule]`	`string`	Pickup point working time shipment terminal
`orders[][delivery][data][shipmentpointPhone]`	`string`	Shipment terminal phone
`orders[][delivery][data][shipmentpointCoordinateLatitude]`	`string`	Shipment terminal coordinates, latitude
`orders[][delivery][data][shipmentpointCoordinateLongitude]`	`string`	Shipment terminal coordinates, longitude
`orders[][delivery][data][pickuppointName]`	`string`	Pickup point name
`orders[][delivery][data][pickuppointCoordinateLatitude]`	`string`	Pickup point coordinates, latitude
`orders[][delivery][data][pickuppointCoordinateLongitude]`	`string`	Pickup point coordinates, longitude
`orders[][delivery][data][extraData]`	`array`	Additional delivery data (`deliveryDataField.code => value`)
`orders[][delivery][data][id]`	`integer`	Courier ID
`orders[][delivery][data][firstName]`	`string`	First name
`orders[][delivery][data][email]`	`string`	E-mail
`orders[][delivery][data][phone]`	`object (CourierPhone)`	Courier phone
`orders[][delivery][data][phone][number]`	`string`	Phone number
`orders[][delivery][data][courierId]`	`integer`	Courier ID
`orders[][delivery][data][statusCode]`	`string`	`deprecated` Delivery status code
`orders[][delivery][data][serviceType]`	`string`	Delivery technology
`orders[][delivery][data][pickuppoint]`	`string`	Pickup pointPickup point name
`orders[][delivery][data][statusName]`	`string`	Delivery status name
`orders[][delivery][data][price]`	`float`	Delivery cost received from delivery service
`orders[][delivery][data][receiverCity]`	`string`	Delivery city nameDelivery city
`orders[][delivery][data][receiverCityRef]`	`string`	Delivery city ID in NewPostDelivery city ID
`orders[][delivery][data][receiverStreet]`	`string`	Delivery street name
`orders[][delivery][data][receiverStreetRef]`	`string`	Delivery street ID in NewPost
`orders[][delivery][data][seatsAmount]`	`integer`	Quantity of sending seats
`orders[][delivery][data][cargoDescription]`	`string`	Cargo description
`orders[][delivery][data][paymentForm]`	`string`	Payment form
`orders[][delivery][data][packageNumber]`	`string`	Package number
`orders[][delivery][data][deliveryDate]`	`string`	Date when the recipient took the order
`orders[][delivery][data][denieReason]`	`string`	Rejection reason
`orders[][delivery][data][declaredValue]`	`float`	Declared value (in entity currency)
`orders[][delivery][data][sendDate]`	`DateTime`	Date of sending
`orders[][delivery][data][deliveryType]`	`string`	Delivery method ID
`orders[][delivery][data][deliveryName]`	`string`	Delivery service name
`orders[][delivery][data][pickupType]`	`integer`	Pickup type
`orders[][delivery][data][pickuppointDescription]`	`string`	Description of pickup point
`orders[][delivery][data][placesCount]`	`integer`	Seats quantity
`orders[][delivery][data][services][]`	`array of strings`	Additional services of delivery
`orders[][delivery][data][comment]`	`string`	Comment to the order
`orders[][delivery][service]`	`object (SerializedDeliveryService)`
`orders[][delivery][service][name]`	`string`	Name
`orders[][delivery][service][code]`	`string`	Symbolic code
`orders[][delivery][cost]`	`double`	Cost
`orders[][delivery][netCost]`	`double`	Delivery net cost
`orders[][delivery][date]`	`DateTime`	Delivery date
`orders[][delivery][address]`	`object (OrderDeliveryAddress)`	Address
`orders[][delivery][address][index]`	`string`	Postal code
`orders[][delivery][address][countryIso]`	`string`	Country ISO code
`orders[][delivery][address][region]`	`string`	Region
`orders[][delivery][address][regionId]`	`integer`	Region ID in Geohelper
`orders[][delivery][address][city]`	`string`	City
`orders[][delivery][address][cityId]`	`integer`	City ID in Geohelper
`orders[][delivery][address][cityType]`	`string`	Locality type
`orders[][delivery][address][street]`	`string`	Street
`orders[][delivery][address][streetId]`	`integer`	Street ID in Geohelper
`orders[][delivery][address][streetType]`	`string`	Street type
`orders[][delivery][address][building]`	`string`	Building
`orders[][delivery][address][flat]`	`string`	Flat/office
`orders[][delivery][address][floor]`	`integer`	Floor
`orders[][delivery][address][block]`	`integer`	Entrance
`orders[][delivery][address][house]`	`string`	House
`orders[][delivery][address][housing]`	`string`	Housing
`orders[][delivery][address][metro]`	`string`	Underground
`orders[][delivery][address][notes]`	`string`	Notes to address
`orders[][delivery][address][text]`	`string`	Address as string
`orders[][delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`orders[][site]`	`string`	Store
`orders[][status]`	`string`	Order status
`orders[][statusComment]`	`string`	Comment to the last status change
`orders[][source]`	`object (SerializedSource)`	Order source
`orders[][source][source]`	`string`	Source
`orders[][source][medium]`	`string`	Medium
`orders[][source][campaign]`	`string`	Campaign
`orders[][source][keyword]`	`string`	Keyword
`orders[][source][content]`	`string`	Ad content
`orders[][items][]`	`array of objects (OrderProduct)`	Order item
`orders[][items][][discount]`	`float`	`deprecated` Monetary discount per item
`orders[][items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`orders[][items][][markingCodes][]`	`array of strings`	Marking codes
`orders[][items][][id]`	`integer`	ID of order item
`orders[][items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`orders[][items][][prices][]`	`array of objects (OrderProductPriceItem)`	Set of total sales prices with the quantity
`orders[][items][][prices][][price]`	`float`	Total price including all discounts on the product and order (in entity currency)
`orders[][items][][prices][][quantity]`	`float`	Quantity of the product at the specified price
`orders[][items][][createdAt]`	`DateTime`	Date of order item creation in the system
`orders[][items][][quantity]`	`float`	Quantity
`orders[][items][][status]`	`string`	Status of the order item
`orders[][items][][comment]`	`string`	Comment to the order item
`orders[][items][][offer]`	`object (Offer)`	SKU
`orders[][items][][offer][externalId]`	`string`	SKU ID in store
`orders[][items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`orders[][items][][offer][name]`	`string`	Name
`orders[][items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`orders[][items][][properties]`	`array`	[array] Additional properties of the order item
`orders[][items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`orders[][items][][ordering]`	`integer`	Ordering
`orders[][fullPaidAt]`	`DateTime`	Full payment date
`orders[][fromApi]`	`boolean`	Order received through API
`orders[][shipmentStore]`	`string`	Shipping warehouse
`orders[][shipmentDate]`	`DateTime`	Shipment date
`orders[][shipped]`	`boolean`	Order is shipped
`orders[][customFields]`	`array`	Associative array of custom fields
`orders[][clientId]`	`string`	Google Analytics clientId

HTTP statuses

Status code	Description
`201`	All orders were successfully uploaded
`400`	Array of orders is not transmitted, or the array is too large
`460`	During uploading the errors occurred. The part of orders is not loaded (the response also contains an "errors" array)

GET /api/v3/orders/{externalId} Getting information on order

Getting information on order

To access the method, the following permission is required order_read.

Method returns full information on the order. You may refer to order either by external order ID (by=externalId), or by internal ID (by=id).

Empty fields without values are not returned.

In the fields orderType, orderMethod, paymentType, paymentStatus, status, site, delivery[code] the symbol code of the element is returned.

In the fields managerId, sourceId the internal ID of the system entity is returned.

Parameters

Parameter	Type	Format	Description
`externalId`	`string`		Order ID

Filter parameters

Parameter Description

by

Template	`id\|externalId`
Default value	`externalId`
Description	Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) order ID. By default it is externalId.

site

Description

Symbolic code of store

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`order`	`object (Order)`	Order
`order[paymentType]`	`string`	`deprecated` Payment type
`order[paymentStatus]`	`string`	`deprecated` Payment status
`order[slug]`	`custom handler result for (int)`	`deprecated` Symbolic code
`order[discount]`	`float`	Monetary discount
`order[discountPercent]`	`float`	Percentage discount
`order[paymentDetail]`	`string`	`deprecated` Payment details
`order[currency]`	`string`	Currency
`order[id]`	`integer`	Order ID
`order[number]`	`string`	Order number
`order[externalId]`	`string`	Order external ID
`order[orderType]`	`string`	Order type
`order[orderMethod]`	`string`	Method
`order[countryIso]`	`string`	Country ISO code
`order[createdAt]`	`DateTime`	Order creation date
`order[statusUpdatedAt]`	`DateTime`	Date of the last order status change
`order[totalSumm]`	`double`	Total sum with discount (in entity currency)
`order[prepaySum]`	`double`	Paid sum (in entity currency)
`order[purchaseSumm]`	`double`	Total purchase sum (in base currency)
`order[mark]`	`integer`	Order evaluation
`order[markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`order[lastName]`	`string`	Surname
`order[firstName]`	`string`	Name
`order[patronymic]`	`string`	Middle name
`order[phone]`	`string`	Phone number
`order[additionalPhone]`	`string`	Additional phone
`order[email]`	`string`	E-mail
`order[call]`	`boolean`	Call required
`order[expired]`	`boolean`	Expired
`order[customerComment]`	`string`	Customer comment
`order[managerComment]`	`string`	Operator comment
`order[managerId]`	`integer`	Manager, responsible for order
`order[customer]`		CustomerCorporate customer
`order[customer][id]`	`integer`	Customer IDCorporate customer ID
`order[customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`order[customer][createdAt]`	`DateTime`	Created atCreated at
`order[customer][managerId]`	`integer`	Customer managerCorporate customer manager
`order[customer][vip]`	`boolean`	VIP customerVIP corporate customer
`order[customer][bad]`	`boolean`	Bad customerBad corporate customer
`order[customer][site]`	`string`	Store, from which the customer cameStore, from which the corporate customer came
`order[customer][firstClientId]`	`string`	First Google Analytics clientIdFirst Google Analytics unique clientId
`order[customer][lastClientId]`	`string`	Last Google Analytics clientIdLast Google Analytics unique clientId
`order[customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`order[customer][personalDiscount]`	`double`	Personal discountPersonal discount
`order[customer][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`order[customer][discountCardNumber]`	`string`	Discount card numberDiscount card number
`order[customer][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)Average gross profit of corporate customer orders (in base currency)
`order[customer][marginSumm]`	`float`	LTV (in base currency)LTV (in base currency)
`order[customer][totalSumm]`	`float`	Orders total sum (in base currency)Orders total sum (in base currency)
`order[customer][averageSumm]`	`float`	Order average sum (in base currency)Order average sum (in base currency)
`order[customer][ordersCount]`	`integer`	Orders quantityOrders quantity
`order[customer][address]`	`object (CustomerAddress)`	Customer address
`order[customer][address][id]`	`integer`	Address ID
`order[customer][address][index]`	`string`	Postal code
`order[customer][address][countryIso]`	`string`	Country ISO code
`order[customer][address][region]`	`string`	Region
`order[customer][address][regionId]`	`integer`	Region ID in Geohelper
`order[customer][address][city]`	`string`	City
`order[customer][address][cityId]`	`integer`	City ID in Geohelper
`order[customer][address][cityType]`	`string`	Locality type
`order[customer][address][street]`	`string`	Street
`order[customer][address][streetId]`	`integer`	Street ID in Geohelper
`order[customer][address][streetType]`	`string`	Street type
`order[customer][address][building]`	`string`	Building
`order[customer][address][flat]`	`string`	Flat/office
`order[customer][address][floor]`	`integer`	Floor
`order[customer][address][block]`	`integer`	Entrance
`order[customer][address][house]`	`string`	House
`order[customer][address][housing]`	`string`	Housing
`order[customer][address][metro]`	`string`	Underground
`order[customer][address][notes]`	`string`	Notes to address
`order[customer][address][text]`	`string`	Address as string
`order[customer][maturationTime]`	`integer`	Maturation time, in seconds
`order[customer][firstName]`	`string`	Name
`order[customer][lastName]`	`string`	Surname
`order[customer][patronymic]`	`string`	Middle name
`order[customer][email]`	`string`	E-mail
`order[customer][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`order[customer][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`order[customer][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`order[customer][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`order[customer][customerSubscriptions][][subscription][channel]`	`string`	Channel
`order[customer][customerSubscriptions][][subscription][name]`	`string`	Name
`order[customer][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`order[customer][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`order[customer][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`order[customer][customerSubscriptions][][subscription][ordering]`	`integer`
`order[customer][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`order[customer][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`order[customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`order[customer][phones][][number]`	`string`	Phone number
`order[customer][birthday]`	`DateTime`	Birthday
`order[customer][source]`	`object (SerializedSource)`	Customer source
`order[customer][source][source]`	`string`	Source
`order[customer][source][medium]`	`string`	Medium
`order[customer][source][campaign]`	`string`	Campaign
`order[customer][source][keyword]`	`string`	Keyword
`order[customer][source][content]`	`string`	Ad content
`order[customer][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`order[customer][mgCustomers][][id]`	`integer`	Customer ID
`order[customer][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`order[customer][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`order[customer][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`order[customer][commentary]`	`string`	`deprecated` Comment
`order[customer][contragentType]`	`string`	Contragent type
`order[customer][legalName]`	`string`	Legal name
`order[customer][legalAddress]`	`string`	Registration address
`order[customer][INN]`	`string`	TIN
`order[customer][OKPO]`	`string`	RNNBO
`order[customer][KPP]`	`string`	IECC
`order[customer][OGRN]`	`string`	PSRN
`order[customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[customer][certificateNumber]`	`string`	Certificate number
`order[customer][certificateDate]`	`DateTime`	Certificate date
`order[customer][BIK]`	`string`	RCBIC
`order[customer][bank]`	`string`	Bank
`order[customer][bankAddress]`	`string`	Bank address
`order[customer][corrAccount]`	`string`	Corresponding account
`order[customer][bankAccount]`	`string`	Settlement account
`order[customer][nickName]`	`string`	Name
`order[contragentType]`	`string`	Contragent type
`order[legalName]`	`string`	Legal name
`order[legalAddress]`	`string`	Registration address
`order[INN]`	`string`	TIN
`order[OKPO]`	`string`	RNNBO
`order[KPP]`	`string`	IECC
`order[OGRN]`	`string`	PSRN
`order[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[certificateNumber]`	`string`	Certificate number
`order[certificateDate]`	`DateTime`	Certificate date
`order[BIK]`	`string`	RCBIC
`order[bank]`	`string`	Bank
`order[bankAddress]`	`string`	Bank address
`order[corrAccount]`	`string`	Corresponding account
`order[bankAccount]`	`string`	Settlement account
`order[delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`order[delivery][code]`	`string`	Delivery type code
`order[delivery][integrationCode]`	`string`	Integration code of delivery type
`order[delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`order[delivery][data][externalId]`	`string`	Delivery id in delivery service`deprecated` Track number (Use `trackNumber` instead)
`order[delivery][data][trackNumber]`	`string`	Track number (`deprecated` for write)Track numberTrack numberTrack number
`order[delivery][data][status]`	`string`	Delivery status codeDelivery status codeDelivery status codeDelivery status code
`order[delivery][data][locked]`	`boolean`	Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`order[delivery][data][pickuppointAddress]`	`string`	Pickup point address
`order[delivery][data][days]`	`string`	Approximate delivery timeApproximate delivery timeApproximate delivery time
`order[delivery][data][statusText]`	`string`	Delivery status nameDelivery status nameDelivery status name
`order[delivery][data][statusDate]`	`DateTime`	Delivery status dateDate of the last delivery status updating
`order[delivery][data][tariff]`	`string`	Tariff code
`order[delivery][data][tariffName]`	`string`	Tariff name
`order[delivery][data][pickuppointId]`	`string`	Pickup point IDPickup point idPickup point ID
`order[delivery][data][pickuppointSchedule]`	`string`	Pickup point working timeSchedule of pickup point
`order[delivery][data][pickuppointPhone]`	`string`	Pickup point phone
`order[delivery][data][payerType]`	`string`	PayerPayer type
`order[delivery][data][statusComment]`	`string`	Comment to delivery status
`order[delivery][data][cost]`	`float`	Delivery cost received from delivery service (in entity currency)Delivery cost received from delivery service (in entity currency)
`order[delivery][data][minTerm]`	`integer`	Minimum delivery term
`order[delivery][data][maxTerm]`	`integer`	Maximum delivery term
`order[delivery][data][shipmentpointId]`	`string`	Shipment terminal IDShipment point id
`order[delivery][data][shipmentpointName]`	`string`	Shipment terminal name
`order[delivery][data][shipmentpointAddress]`	`string`	Shipment terminal address
`order[delivery][data][shipmentpointSchedule]`	`string`	Pickup point working time shipment terminal
`order[delivery][data][shipmentpointPhone]`	`string`	Shipment terminal phone
`order[delivery][data][shipmentpointCoordinateLatitude]`	`string`	Shipment terminal coordinates, latitude
`order[delivery][data][shipmentpointCoordinateLongitude]`	`string`	Shipment terminal coordinates, longitude
`order[delivery][data][pickuppointName]`	`string`	Pickup point name
`order[delivery][data][pickuppointCoordinateLatitude]`	`string`	Pickup point coordinates, latitude
`order[delivery][data][pickuppointCoordinateLongitude]`	`string`	Pickup point coordinates, longitude
`order[delivery][data][extraData]`	`array`	Additional delivery data (`deliveryDataField.code => value`)
`order[delivery][data][id]`	`integer`	Courier ID
`order[delivery][data][firstName]`	`string`	First name
`order[delivery][data][email]`	`string`	E-mail
`order[delivery][data][phone]`	`object (CourierPhone)`	Courier phone
`order[delivery][data][phone][number]`	`string`	Phone number
`order[delivery][data][courierId]`	`integer`	Courier ID
`order[delivery][data][statusCode]`	`string`	`deprecated` Delivery status code
`order[delivery][data][serviceType]`	`string`	Delivery technology
`order[delivery][data][pickuppoint]`	`string`	Pickup pointPickup point name
`order[delivery][data][statusName]`	`string`	Delivery status name
`order[delivery][data][price]`	`float`	Delivery cost received from delivery service
`order[delivery][data][receiverCity]`	`string`	Delivery city nameDelivery city
`order[delivery][data][receiverCityRef]`	`string`	Delivery city ID in NewPostDelivery city ID
`order[delivery][data][receiverStreet]`	`string`	Delivery street name
`order[delivery][data][receiverStreetRef]`	`string`	Delivery street ID in NewPost
`order[delivery][data][seatsAmount]`	`integer`	Quantity of sending seats
`order[delivery][data][cargoDescription]`	`string`	Cargo description
`order[delivery][data][paymentForm]`	`string`	Payment form
`order[delivery][data][packageNumber]`	`string`	Package number
`order[delivery][data][deliveryDate]`	`string`	Date when the recipient took the order
`order[delivery][data][denieReason]`	`string`	Rejection reason
`order[delivery][data][declaredValue]`	`float`	Declared value (in entity currency)
`order[delivery][data][sendDate]`	`DateTime`	Date of sending
`order[delivery][data][deliveryType]`	`string`	Delivery method ID
`order[delivery][data][deliveryName]`	`string`	Delivery service name
`order[delivery][data][pickupType]`	`integer`	Pickup type
`order[delivery][data][pickuppointDescription]`	`string`	Description of pickup point
`order[delivery][data][placesCount]`	`integer`	Seats quantity
`order[delivery][data][services][]`	`array of strings`	Additional services of delivery
`order[delivery][data][comment]`	`string`	Comment to the order
`order[delivery][service]`	`object (SerializedDeliveryService)`
`order[delivery][service][name]`	`string`	Name
`order[delivery][service][code]`	`string`	Symbolic code
`order[delivery][cost]`	`double`	Cost
`order[delivery][netCost]`	`double`	Delivery net cost
`order[delivery][date]`	`DateTime`	Delivery date
`order[delivery][address]`	`object (OrderDeliveryAddress)`	Address
`order[delivery][address][index]`	`string`	Postal code
`order[delivery][address][countryIso]`	`string`	Country ISO code
`order[delivery][address][region]`	`string`	Region
`order[delivery][address][regionId]`	`integer`	Region ID in Geohelper
`order[delivery][address][city]`	`string`	City
`order[delivery][address][cityId]`	`integer`	City ID in Geohelper
`order[delivery][address][cityType]`	`string`	Locality type
`order[delivery][address][street]`	`string`	Street
`order[delivery][address][streetId]`	`integer`	Street ID in Geohelper
`order[delivery][address][streetType]`	`string`	Street type
`order[delivery][address][building]`	`string`	Building
`order[delivery][address][flat]`	`string`	Flat/office
`order[delivery][address][floor]`	`integer`	Floor
`order[delivery][address][block]`	`integer`	Entrance
`order[delivery][address][house]`	`string`	House
`order[delivery][address][housing]`	`string`	Housing
`order[delivery][address][metro]`	`string`	Underground
`order[delivery][address][notes]`	`string`	Notes to address
`order[delivery][address][text]`	`string`	Address as string
`order[delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`order[site]`	`string`	Store
`order[status]`	`string`	Order status
`order[statusComment]`	`string`	Comment to the last status change
`order[source]`	`object (SerializedSource)`	Order source
`order[source][source]`	`string`	Source
`order[source][medium]`	`string`	Medium
`order[source][campaign]`	`string`	Campaign
`order[source][keyword]`	`string`	Keyword
`order[source][content]`	`string`	Ad content
`order[items][]`	`array of objects (OrderProduct)`	Order item
`order[items][][discount]`	`float`	`deprecated` Monetary discount per item
`order[items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`order[items][][markingCodes][]`	`array of strings`	Marking codes
`order[items][][id]`	`integer`	ID of order item
`order[items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`order[items][][prices][]`	`array of objects (OrderProductPriceItem)`	Set of total sales prices with the quantity
`order[items][][prices][][price]`	`float`	Total price including all discounts on the product and order (in entity currency)
`order[items][][prices][][quantity]`	`float`	Quantity of the product at the specified price
`order[items][][createdAt]`	`DateTime`	Date of order item creation in the system
`order[items][][quantity]`	`float`	Quantity
`order[items][][status]`	`string`	Status of the order item
`order[items][][comment]`	`string`	Comment to the order item
`order[items][][offer]`	`object (Offer)`	SKU
`order[items][][offer][externalId]`	`string`	SKU ID in store
`order[items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`order[items][][offer][name]`	`string`	Name
`order[items][][offer][quantity]`	`float`	Available quantity
`order[items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`order[items][][properties][]`	`array`	[array] Additional properties of the order item
`order[items][][properties][][code]`	`string`	Property code (not mandatory field, the code can be transmitted in the property key)
`order[items][][properties][][name]`	`string`	Property name
`order[items][][properties][][value]`	`string`	Property value
`order[items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`order[items][][ordering]`	`integer`	Ordering
`order[fullPaidAt]`	`DateTime`	Full payment date
`order[fromApi]`	`boolean`	Order received through API
`order[shipmentStore]`	`string`	Shipping warehouse
`order[shipmentDate]`	`DateTime`	Shipment date
`order[shipped]`	`boolean`	Order is shipped
`order[customFields]`	`array`	Associative array of custom fields
`order[clientId]`	`string`	Google Analytics clientId

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Order not found

POST /api/v3/orders/{externalId}/edit Order editing

Order editing

To access the method, the following permission is required order_write.

Method allows to edit the order. You may refer to order either by external order ID (by=externalId), or by internal ID (by=id).

In case of trying to edit the removed order, the system returns state=removed in the answer.

In the fields order[managerId], order[sourceId] the internal ID of the system entity is specified.

The comment order[statusComment] cannot be changed without changing the order status order[status].

order[items][][offerId] – SKU ID;
order[items][][productId] – external ID of item or SKU;
order[items][][xmlId] – SKU ID in the warehouse system.

If the values are set for several fields, they will be processed in the following above order.

The order of order items order[items][] is saved in response.

Parameters

Parameter	Type	Format	Description
`by`	`string`		Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) order ID. By default it is externalId.
`site`	`string`		Symbolic code of store
`order`	`object (SerializedOrder)`
`order[paymentType]`	`string`		`deprecated` Payment type
`order[paymentStatus]`	`string`		`deprecated` Payment status
`order[paymentDetail]`	`string`		`deprecated` Payment details
`order[number]`	`string`		Order number
`order[externalId]`	`string`		Order external ID
`order[countryIso]`	`string`		Country ISO code
`order[createdAt]`	`DateTime`	`Y-m-d H:i:s`	Order creation date
`order[mark]`	`integer`		Order evaluation
`order[markDatetime]`	`DateTime`	`Y-m-d H:i:s`	Date and time of getting evaluation from customer
`order[lastName]`	`string`		Surname
`order[firstName]`	`string`		Name
`order[patronymic]`	`string`		Middle name
`order[phone]`	`string`		Phone number
`order[additionalPhone]`	`string`		Additional phone
`order[email]`	`string`		E-mail
`order[call]`	`boolean`		Call required
`order[expired]`	`boolean`		Expired
`order[customerComment]`	`string`		Customer comment
`order[managerComment]`	`string`		Operator comment
`order[statusComment]`	`string`		Comment to the last status change
`order[shipmentDate]`	`DateTime`	`Y-m-d`	Shipment date
`order[shipped]`	`boolean`		Order is shipped
`order[contragentType]`	`string`		Contragent type
`order[legalName]`	`string`		Legal name
`order[legalAddress]`	`string`		Registration address
`order[INN]`	`string`		TIN
`order[OKPO]`	`string`		RNNBO
`order[KPP]`	`string`		IECC
`order[OGRN]`	`string`		PSRN
`order[OGRNIP]`	`string`		PSRN of Individual entrepreneur
`order[certificateNumber]`	`string`		Certificate number
`order[certificateDate]`	`DateTime`	`Y-m-d H:i:s`	Certificate date
`order[BIK]`	`string`		RCBIC
`order[bank]`	`string`		Bank
`order[bankAddress]`	`string`		Bank address
`order[corrAccount]`	`string`		Corresponding account
`order[bankAccount]`	`string`		Settlement account
`order[customFields]`	`array`		Associative array of custom fields
`order[orderType]`	`string`		Order type
`order[orderMethod]`	`string`		Method
`order[customerId]`	`string`		External ID of customer, who made orders (outdated)
`order[customer]`	`object (SerializedRelationCustomer)`		Customer
`order[customer][id]`	`integer`		Customer internal ID
`order[customer][externalId]`	`string`		Customer external ID
`order[customer][browserId]`	`string`		Device ID in Collector
`order[customer][site]`	`string`		Store code, required when externalId is specified
`order[managerId]`	`integer`		Manager, responsible for order
`order[status]`	`string`		Order status
`order[items][]`	`array of objects (SerializedOrderProduct)`
`order[items][][markingCodes][]`	`array of strings`		Marking codes
`order[items][][id]`	`integer`		ID of order item
`order[items][][initialPrice]`	`double`		Item price/SKU (in entity currency)
`order[items][][createdAt]`	`DateTime`	`Y-m-d H:i:s`	Date of order item creation in the system
`order[items][][quantity]`	`float`		Quantity
`order[items][][comment]`	`string`		Comment to the order item
`order[items][][properties][]`	`array`		[array] Additional properties of the order item
`order[items][][properties][][code]`	`string`	`{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}}`	Property code (not mandatory field, the code can be transmitted in the property key)
`order[items][][properties][][name]`	`string`	`{not blank}`	Property name
`order[items][][properties][][value]`	`string`	`{not blank}`	Property value
`order[items][][purchasePrice]`	`double`		Purchasing price (in base currency)
`order[items][][ordering]`	`integer`		Ordering
`order[items][][offerId]`	`string`		`deprecated` SKU identifier in the system
`order[items][][productId]`	`string`		Identifier of item or SKU from external site
`order[items][][xmlId]`	`string`		SKU ID in the warehouse system
`order[items][][productName]`	`string`		Item name
`order[items][][status]`	`string`		Status of the order item
`order[items][][discount]`	`string`		`deprecated` Monetary discount per item
`order[items][][discountPercent]`	`string`		`deprecated` Percentage discount per item
`order[delivery]`	`object (SerializedOrderDelivery)`		Data on delivery
`order[delivery][code]`	`string`		Delivery type code
`order[delivery][data]`			Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`order[delivery][data][externalId]`	`string`		Delivery id in delivery service
`order[delivery][data][trackNumber]`	`string`		Track number (`deprecated` for write)Track numberTrack number
`order[delivery][data][locked]`	`boolean`		Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`order[delivery][data][tariff]`	`string`		Tariff code
`order[delivery][data][pickuppointId]`	`string`		Pickup point IDPickup point idPickup point ID
`order[delivery][data][payerType]`	`string`		PayerPayer type
`order[delivery][data][shipmentpointId]`	`string`		Shipment terminal IDShipment point id
`order[delivery][data][extraData]`	`array`		Additional delivery data (`deliveryDataField.code => value`)
`order[delivery][data][courierId]`	`integer`		Courier ID
`order[delivery][data][serviceType]`	`string`		Delivery technology
`order[delivery][data][pickuppoint]`	`string`		Pickup point
`order[delivery][data][receiverCity]`	`string`		Delivery city nameDelivery city
`order[delivery][data][receiverCityRef]`	`string`		Delivery city ID in NewPostDelivery city ID
`order[delivery][data][receiverStreet]`	`string`		Delivery street name
`order[delivery][data][receiverStreetRef]`	`string`		Delivery street ID in NewPost
`order[delivery][data][seatsAmount]`	`integer`		Quantity of sending seats
`order[delivery][data][cargoDescription]`	`string`		Cargo description
`order[delivery][data][paymentForm]`	`string`		Payment form
`order[delivery][data][packageNumber]`	`string`		Package number
`order[delivery][data][declaredValue]`	`float`		Declared value (in entity currency)
`order[delivery][data][sendDate]`	`DateTime`	`Y-m-d`	Date of sending
`order[delivery][data][deliveryType]`	`string`		Delivery method ID
`order[delivery][data][pickupType]`	`integer`		Pickup type
`order[delivery][data][placesCount]`	`integer`		Seats quantity
`order[delivery][data][services][]`	`array of strings`		Additional services of delivery
`order[delivery][data][comment]`	`string`		Comment to the order
`order[delivery][service]`	`object (SerializedDeliveryService)`
`order[delivery][service][name]`	`string`		Name
`order[delivery][service][code]`	`string`		Symbolic code
`order[delivery][service][deliveryType]`	`string`		Delivery type
`order[delivery][cost]`	`double`		Cost
`order[delivery][netCost]`	`double`		Delivery net cost
`order[delivery][date]`	`DateTime`	`Y-m-d`	Delivery date
`order[delivery][address]`	`object (OrderDeliveryAddress)`		Address
`order[delivery][address][index]`	`string`		Postal code
`order[delivery][address][countryIso]`	`string`		Country ISO code
`order[delivery][address][region]`	`string`		Region
`order[delivery][address][regionId]`	`integer`		Region ID in Geohelper
`order[delivery][address][city]`	`string`		City
`order[delivery][address][cityId]`	`integer`		City ID in Geohelper
`order[delivery][address][cityType]`	`string`		Locality type
`order[delivery][address][street]`	`string`		Street
`order[delivery][address][streetId]`	`integer`		Street ID in Geohelper
`order[delivery][address][streetType]`	`string`		Street type
`order[delivery][address][building]`	`string`		Building
`order[delivery][address][flat]`	`string`		Flat/office
`order[delivery][address][floor]`	`integer`		Floor
`order[delivery][address][block]`	`integer`		Entrance
`order[delivery][address][house]`	`string`		House
`order[delivery][address][housing]`	`string`		Housing
`order[delivery][address][metro]`	`string`		Underground
`order[delivery][address][notes]`	`string`		Notes to address
`order[delivery][address][text]`	`string`		Address as string
`order[delivery][address][deliveryTime]`	`string`		`deprecated` Delivery time
`order[source]`	`object (SerializedSource)`		Order source
`order[source][source]`	`string`		Source
`order[source][medium]`	`string`		Medium
`order[source][campaign]`	`string`		Campaign
`order[source][keyword]`	`string`		Keyword
`order[source][content]`	`string`		Ad content
`order[shipmentStore]`	`string`		Shipping warehouse
`order[discount]`	`string`		Monetary discount
`order[discountPercent]`	`string`		Percentage discount

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Order internal ID
`order`	`object (Order)`	Order
`order[paymentType]`	`string`	`deprecated` Payment type
`order[paymentStatus]`	`string`	`deprecated` Payment status
`order[slug]`	`custom handler result for (int)`	`deprecated` Symbolic code
`order[discount]`	`float`	Monetary discount
`order[discountPercent]`	`float`	Percentage discount
`order[paymentDetail]`	`string`	`deprecated` Payment details
`order[currency]`	`string`	Currency
`order[id]`	`integer`	Order ID
`order[number]`	`string`	Order number
`order[externalId]`	`string`	Order external ID
`order[orderType]`	`string`	Order type
`order[orderMethod]`	`string`	Method
`order[countryIso]`	`string`	Country ISO code
`order[createdAt]`	`DateTime`	Order creation date
`order[statusUpdatedAt]`	`DateTime`	Date of the last order status change
`order[totalSumm]`	`double`	Total sum with discount (in entity currency)
`order[prepaySum]`	`double`	Paid sum (in entity currency)
`order[purchaseSumm]`	`double`	Total purchase sum (in base currency)
`order[mark]`	`integer`	Order evaluation
`order[markDatetime]`	`DateTime`	Date and time of getting evaluation from customer
`order[lastName]`	`string`	Surname
`order[firstName]`	`string`	Name
`order[patronymic]`	`string`	Middle name
`order[phone]`	`string`	Phone number
`order[additionalPhone]`	`string`	Additional phone
`order[email]`	`string`	E-mail
`order[call]`	`boolean`	Call required
`order[expired]`	`boolean`	Expired
`order[customerComment]`	`string`	Customer comment
`order[managerComment]`	`string`	Operator comment
`order[managerId]`	`integer`	Manager, responsible for order
`order[customer]`		CustomerCorporate customer
`order[customer][id]`	`integer`	Customer IDCorporate customer ID
`order[customer][externalId]`	`string`	Customer external IDCorporate customer external ID
`order[customer][createdAt]`	`DateTime`	Created atCreated at
`order[customer][managerId]`	`integer`	Customer managerCorporate customer manager
`order[customer][vip]`	`boolean`	VIP customerVIP corporate customer
`order[customer][bad]`	`boolean`	Bad customerBad corporate customer
`order[customer][site]`	`string`	Store, from which the customer cameStore, from which the corporate customer came
`order[customer][firstClientId]`	`string`	First Google Analytics clientIdFirst Google Analytics unique clientId
`order[customer][lastClientId]`	`string`	Last Google Analytics clientIdLast Google Analytics unique clientId
`order[customer][customFields]`	`array`	Associative array of custom fieldsAssociative array of custom fields
`order[customer][personalDiscount]`	`double`	Personal discountPersonal discount
`order[customer][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`order[customer][discountCardNumber]`	`string`	Discount card numberDiscount card number
`order[customer][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)Average gross profit of corporate customer orders (in base currency)
`order[customer][marginSumm]`	`float`	LTV (in base currency)LTV (in base currency)
`order[customer][totalSumm]`	`float`	Orders total sum (in base currency)Orders total sum (in base currency)
`order[customer][averageSumm]`	`float`	Order average sum (in base currency)Order average sum (in base currency)
`order[customer][ordersCount]`	`integer`	Orders quantityOrders quantity
`order[customer][address]`	`object (CustomerAddress)`	Customer address
`order[customer][address][id]`	`integer`	Address ID
`order[customer][address][index]`	`string`	Postal code
`order[customer][address][countryIso]`	`string`	Country ISO code
`order[customer][address][region]`	`string`	Region
`order[customer][address][regionId]`	`integer`	Region ID in Geohelper
`order[customer][address][city]`	`string`	City
`order[customer][address][cityId]`	`integer`	City ID in Geohelper
`order[customer][address][cityType]`	`string`	Locality type
`order[customer][address][street]`	`string`	Street
`order[customer][address][streetId]`	`integer`	Street ID in Geohelper
`order[customer][address][streetType]`	`string`	Street type
`order[customer][address][building]`	`string`	Building
`order[customer][address][flat]`	`string`	Flat/office
`order[customer][address][floor]`	`integer`	Floor
`order[customer][address][block]`	`integer`	Entrance
`order[customer][address][house]`	`string`	House
`order[customer][address][housing]`	`string`	Housing
`order[customer][address][metro]`	`string`	Underground
`order[customer][address][notes]`	`string`	Notes to address
`order[customer][address][text]`	`string`	Address as string
`order[customer][maturationTime]`	`integer`	Maturation time, in seconds
`order[customer][firstName]`	`string`	Name
`order[customer][lastName]`	`string`	Surname
`order[customer][patronymic]`	`string`	Middle name
`order[customer][email]`	`string`	E-mail
`order[customer][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`order[customer][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`order[customer][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`order[customer][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`order[customer][customerSubscriptions][][subscription][channel]`	`string`	Channel
`order[customer][customerSubscriptions][][subscription][name]`	`string`	Name
`order[customer][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`order[customer][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`order[customer][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`order[customer][customerSubscriptions][][subscription][ordering]`	`integer`
`order[customer][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`order[customer][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`order[customer][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`order[customer][phones][][number]`	`string`	Phone number
`order[customer][birthday]`	`DateTime`	Birthday
`order[customer][source]`	`object (SerializedSource)`	Customer source
`order[customer][source][source]`	`string`	Source
`order[customer][source][medium]`	`string`	Medium
`order[customer][source][campaign]`	`string`	Campaign
`order[customer][source][keyword]`	`string`	Keyword
`order[customer][source][content]`	`string`	Ad content
`order[customer][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`order[customer][mgCustomers][][id]`	`integer`	Customer ID
`order[customer][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`order[customer][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`order[customer][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`order[customer][commentary]`	`string`	`deprecated` Comment
`order[customer][contragentType]`	`string`	Contragent type
`order[customer][legalName]`	`string`	Legal name
`order[customer][legalAddress]`	`string`	Registration address
`order[customer][INN]`	`string`	TIN
`order[customer][OKPO]`	`string`	RNNBO
`order[customer][KPP]`	`string`	IECC
`order[customer][OGRN]`	`string`	PSRN
`order[customer][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[customer][certificateNumber]`	`string`	Certificate number
`order[customer][certificateDate]`	`DateTime`	Certificate date
`order[customer][BIK]`	`string`	RCBIC
`order[customer][bank]`	`string`	Bank
`order[customer][bankAddress]`	`string`	Bank address
`order[customer][corrAccount]`	`string`	Corresponding account
`order[customer][bankAccount]`	`string`	Settlement account
`order[customer][nickName]`	`string`	Name
`order[contragentType]`	`string`	Contragent type
`order[legalName]`	`string`	Legal name
`order[legalAddress]`	`string`	Registration address
`order[INN]`	`string`	TIN
`order[OKPO]`	`string`	RNNBO
`order[KPP]`	`string`	IECC
`order[OGRN]`	`string`	PSRN
`order[OGRNIP]`	`string`	PSRN of Individual entrepreneur
`order[certificateNumber]`	`string`	Certificate number
`order[certificateDate]`	`DateTime`	Certificate date
`order[BIK]`	`string`	RCBIC
`order[bank]`	`string`	Bank
`order[bankAddress]`	`string`	Bank address
`order[corrAccount]`	`string`	Corresponding account
`order[bankAccount]`	`string`	Settlement account
`order[delivery]`	`object (SerializedOrderDelivery)`	Data on delivery
`order[delivery][code]`	`string`	Delivery type code
`order[delivery][integrationCode]`	`string`	Integration code of delivery type
`order[delivery][data]`		Data of the delivery service, connected by APICourier delivery service dataNew Post delivery service dataDDelivery delivery service dataKazPost delivery service data
`order[delivery][data][externalId]`	`string`	Delivery id in delivery service`deprecated` Track number (Use `trackNumber` instead)
`order[delivery][data][trackNumber]`	`string`	Track number (`deprecated` for write)Track numberTrack numberTrack number
`order[delivery][data][status]`	`string`	Delivery status codeDelivery status codeDelivery status codeDelivery status code
`order[delivery][data][locked]`	`boolean`	Do not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery serviceDo not synchronize with the delivery service
`order[delivery][data][pickuppointAddress]`	`string`	Pickup point address
`order[delivery][data][days]`	`string`	Approximate delivery timeApproximate delivery timeApproximate delivery time
`order[delivery][data][statusText]`	`string`	Delivery status nameDelivery status nameDelivery status name
`order[delivery][data][statusDate]`	`DateTime`	Delivery status dateDate of the last delivery status updating
`order[delivery][data][tariff]`	`string`	Tariff code
`order[delivery][data][tariffName]`	`string`	Tariff name
`order[delivery][data][pickuppointId]`	`string`	Pickup point IDPickup point idPickup point ID
`order[delivery][data][pickuppointSchedule]`	`string`	Pickup point working timeSchedule of pickup point
`order[delivery][data][pickuppointPhone]`	`string`	Pickup point phone
`order[delivery][data][payerType]`	`string`	PayerPayer type
`order[delivery][data][statusComment]`	`string`	Comment to delivery status
`order[delivery][data][cost]`	`float`	Delivery cost received from delivery service (in entity currency)Delivery cost received from delivery service (in entity currency)
`order[delivery][data][minTerm]`	`integer`	Minimum delivery term
`order[delivery][data][maxTerm]`	`integer`	Maximum delivery term
`order[delivery][data][shipmentpointId]`	`string`	Shipment terminal IDShipment point id
`order[delivery][data][shipmentpointName]`	`string`	Shipment terminal name
`order[delivery][data][shipmentpointAddress]`	`string`	Shipment terminal address
`order[delivery][data][shipmentpointSchedule]`	`string`	Pickup point working time shipment terminal
`order[delivery][data][shipmentpointPhone]`	`string`	Shipment terminal phone
`order[delivery][data][shipmentpointCoordinateLatitude]`	`string`	Shipment terminal coordinates, latitude
`order[delivery][data][shipmentpointCoordinateLongitude]`	`string`	Shipment terminal coordinates, longitude
`order[delivery][data][pickuppointName]`	`string`	Pickup point name
`order[delivery][data][pickuppointCoordinateLatitude]`	`string`	Pickup point coordinates, latitude
`order[delivery][data][pickuppointCoordinateLongitude]`	`string`	Pickup point coordinates, longitude
`order[delivery][data][extraData]`	`array`	Additional delivery data (`deliveryDataField.code => value`)
`order[delivery][data][id]`	`integer`	Courier ID
`order[delivery][data][firstName]`	`string`	First name
`order[delivery][data][email]`	`string`	E-mail
`order[delivery][data][phone]`	`object (CourierPhone)`	Courier phone
`order[delivery][data][phone][number]`	`string`	Phone number
`order[delivery][data][courierId]`	`integer`	Courier ID
`order[delivery][data][statusCode]`	`string`	`deprecated` Delivery status code
`order[delivery][data][serviceType]`	`string`	Delivery technology
`order[delivery][data][pickuppoint]`	`string`	Pickup pointPickup point name
`order[delivery][data][statusName]`	`string`	Delivery status name
`order[delivery][data][price]`	`float`	Delivery cost received from delivery service
`order[delivery][data][receiverCity]`	`string`	Delivery city nameDelivery city
`order[delivery][data][receiverCityRef]`	`string`	Delivery city ID in NewPostDelivery city ID
`order[delivery][data][receiverStreet]`	`string`	Delivery street name
`order[delivery][data][receiverStreetRef]`	`string`	Delivery street ID in NewPost
`order[delivery][data][seatsAmount]`	`integer`	Quantity of sending seats
`order[delivery][data][cargoDescription]`	`string`	Cargo description
`order[delivery][data][paymentForm]`	`string`	Payment form
`order[delivery][data][packageNumber]`	`string`	Package number
`order[delivery][data][deliveryDate]`	`string`	Date when the recipient took the order
`order[delivery][data][denieReason]`	`string`	Rejection reason
`order[delivery][data][declaredValue]`	`float`	Declared value (in entity currency)
`order[delivery][data][sendDate]`	`DateTime`	Date of sending
`order[delivery][data][deliveryType]`	`string`	Delivery method ID
`order[delivery][data][deliveryName]`	`string`	Delivery service name
`order[delivery][data][pickupType]`	`integer`	Pickup type
`order[delivery][data][pickuppointDescription]`	`string`	Description of pickup point
`order[delivery][data][placesCount]`	`integer`	Seats quantity
`order[delivery][data][services][]`	`array of strings`	Additional services of delivery
`order[delivery][data][comment]`	`string`	Comment to the order
`order[delivery][service]`	`object (SerializedDeliveryService)`
`order[delivery][service][name]`	`string`	Name
`order[delivery][service][code]`	`string`	Symbolic code
`order[delivery][cost]`	`double`	Cost
`order[delivery][netCost]`	`double`	Delivery net cost
`order[delivery][date]`	`DateTime`	Delivery date
`order[delivery][address]`	`object (OrderDeliveryAddress)`	Address
`order[delivery][address][index]`	`string`	Postal code
`order[delivery][address][countryIso]`	`string`	Country ISO code
`order[delivery][address][region]`	`string`	Region
`order[delivery][address][regionId]`	`integer`	Region ID in Geohelper
`order[delivery][address][city]`	`string`	City
`order[delivery][address][cityId]`	`integer`	City ID in Geohelper
`order[delivery][address][cityType]`	`string`	Locality type
`order[delivery][address][street]`	`string`	Street
`order[delivery][address][streetId]`	`integer`	Street ID in Geohelper
`order[delivery][address][streetType]`	`string`	Street type
`order[delivery][address][building]`	`string`	Building
`order[delivery][address][flat]`	`string`	Flat/office
`order[delivery][address][floor]`	`integer`	Floor
`order[delivery][address][block]`	`integer`	Entrance
`order[delivery][address][house]`	`string`	House
`order[delivery][address][housing]`	`string`	Housing
`order[delivery][address][metro]`	`string`	Underground
`order[delivery][address][notes]`	`string`	Notes to address
`order[delivery][address][text]`	`string`	Address as string
`order[delivery][address][deliveryTime]`	`string`	`deprecated` Delivery time
`order[site]`	`string`	Store
`order[status]`	`string`	Order status
`order[statusComment]`	`string`	Comment to the last status change
`order[source]`	`object (SerializedSource)`	Order source
`order[source][source]`	`string`	Source
`order[source][medium]`	`string`	Medium
`order[source][campaign]`	`string`	Campaign
`order[source][keyword]`	`string`	Keyword
`order[source][content]`	`string`	Ad content
`order[items][]`	`array of objects (OrderProduct)`	Order item
`order[items][][discount]`	`float`	`deprecated` Monetary discount per item
`order[items][][discountPercent]`	`float`	`deprecated` Percentage discount per item
`order[items][][markingCodes][]`	`array of strings`	Marking codes
`order[items][][id]`	`integer`	ID of order item
`order[items][][initialPrice]`	`double`	Item price/SKU (in entity currency)
`order[items][][prices][]`	`array of objects (OrderProductPriceItem)`	Set of total sales prices with the quantity
`order[items][][prices][][price]`	`float`	Total price including all discounts on the product and order (in entity currency)
`order[items][][prices][][quantity]`	`float`	Quantity of the product at the specified price
`order[items][][createdAt]`	`DateTime`	Date of order item creation in the system
`order[items][][quantity]`	`float`	Quantity
`order[items][][status]`	`string`	Status of the order item
`order[items][][comment]`	`string`	Comment to the order item
`order[items][][offer]`	`object (Offer)`	SKU
`order[items][][offer][externalId]`	`string`	SKU ID in store
`order[items][][offer][xmlId]`	`string`	SKU ID in the warehouse system
`order[items][][offer][name]`	`string`	Name
`order[items][][isCanceled]`	`boolean`	This order item is cancelled in the order
`order[items][][properties]`	`array`	[array] Additional properties of the order item
`order[items][][purchasePrice]`	`double`	Purchasing price (in base currency)
`order[items][][ordering]`	`integer`	Ordering
`order[fullPaidAt]`	`DateTime`	Full payment date
`order[fromApi]`	`boolean`	Order received through API
`order[shipmentStore]`	`string`	Shipping warehouse
`order[shipmentDate]`	`DateTime`	Shipment date
`order[shipped]`	`boolean`	Order is shipped
`order[customFields]`	`array`	Associative array of custom fields
`order[clientId]`	`string`	Google Analytics clientId
`state`	`string`	Order condition (not returned by default)

HTTP statuses

Status code	Description
`200`	The order was successfully changed
`400`	Error on order editing

Orders picking

GET /api/v3/orders/packs Getting the list of packs matched the specified filter

Getting the list of packs matched the specified filter

To access the method, the following permission is required order_read.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100], [20\|50\|100\|250]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (OrderProductPackFilterV3)`
`filter[store]`	`string`		Warehouse
`filter[ids]`	`array of integers`		Array of order product pack's ID
`filter[itemId]`	`integer`	`{range: {>=0}}`	Product ID
`filter[offerXmlId]`	`string`	`{length: {max: 255}}`	SKU XMLId
`filter[offerExternalId]`	`string`	`{length: {max: 255}}`	SKU external ID
`filter[orderId]`	`integer`	`{range: {>=0}}`	Order ID
`filter[orderExternalId]`	`string`	`{length: {max: 255}}`	Order external ID
`filter[shipmentDateFrom]`	`DateTimeInterface`		Shipment date from
`filter[shipmentDateTo]`	`DateTimeInterface`		Shipment date to
`filter[invoiceNumber]`	`string`	`{length: {max: 255}}`	Tax number
`filter[deliveryNoteNumber]`	`string`	`{length: {max: 255}}`	Way bill number

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`packs[]`	`array of objects (OrderProductPack)`	Pack - items pack, within the one item position, from one warehouse
`packs[][id]`	`integer`	ID
`packs[][purchasePrice]`	`float`	Purchasing price (in base currency)
`packs[][quantity]`	`float`	Item quantity in pack
`packs[][store]`	`string`	Warehouse
`packs[][item]`	`object (OrderProduct)`	Order item
`packs[][item][id]`	`integer`	ID of order item
`packs[][item][order]`	`object (Order)`	Order
`packs[][item][order][id]`	`integer`	Order ID
`packs[][item][offer]`	`object (Offer)`	SKU
`packs[][item][offer][externalId]`	`string`	SKU ID in store
`packs[][item][offer][xmlId]`	`string`	SKU ID in the warehouse system
`packs[][shipmentDate]`	`DateTime`	Pack shipment date
`packs[][invoiceNumber]`	`string`	Tax number
`packs[][deliveryNoteNumber]`	`string`	Packing list number

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/orders/packs/create Pack creation

Pack creation

To access the method, the following permission is required order_write.

The method creates a pack and returns its internal ID. The creation of the pack is not allowed for cancelled SKUs and services. There will be an error message in this case.

Parameters

Parameter	Type	Description
`pack`	`object (SerializedOrderProductPack)`
`pack[purchasePrice]`	`float`	Purchasing price (in base currency)
`pack[quantity]`	`float`	Item quantity in pack
`pack[store]`	`string`	Warehouse
`pack[shipmentDate]`	`DateTime`	Pack shipment date
`pack[invoiceNumber]`	`string`	Tax number
`pack[deliveryNoteNumber]`	`string`	Packing list number
`pack[itemId]`	`integer`	Order item ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Pack ID

HTTP statuses

Status code	Description
`201`	The pack is successfully created
`400`	Error on pack creation

GET /api/v3/orders/packs/history Getting the history of order packing

Getting the history of order packing

To access the method, the following permission is required order_read.

The result is returned per-page. In the field pagination there is an information about the pagination.

More information about the work with history you can find in other article.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (OrderProductPackHistoryFilterType)`
`filter[orderId]`	`integer`	`{range: {>=0}}`	Order internal identifier
`filter[sinceId]`	`integer`	`{range: {>=0}}`	The lower limit on entry id in the history (excluding boundary)
`filter[orderExternalId]`	`string`	`{length: {max: 255}}`	Order identifier in store
`filter[startDate]`	`DateTime`	`Y-m-d H:i:s`	Time of change (from)
`filter[endDate]`	`DateTime`	`Y-m-d H:i:s`	Time of change (to)

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`generatedAt`	`DateTime`	Time of response formation
`history[]`	`array of objects (OrderProductPackHistory)`	Set of changes in the collecting history
`history[][id]`	`integer`	Internal identifier of entry in the history
`history[][createdAt]`	`DateTime`	Date of making change
`history[][created]`	`boolean`	Flag is displayed when creation of new pack of items
`history[][deleted]`	`boolean`	Flag is displayed when removing the new pack of items
`history[][field]`	`string`	Name of changed field
`history[][oldValue]`	`object (HistoryField)`	Old value
`history[][newValue]`	`object (HistoryField)`	New value
`history[][pack]`	`object (OrderProductPack)`	Pack - items pack, within the one item position, from one warehouse
`history[][pack][id]`	`integer`	ID
`history[][pack][purchasePrice]`	`float`	Purchasing price (in base currency)
`history[][pack][quantity]`	`float`	Item quantity in pack
`history[][pack][store]`	`object (Store)`	Warehouse
`history[][pack][store][code]`	`string`	Symbolic code
`history[][pack][item]`	`object (OrderProduct)`	Order item
`history[][pack][item][id]`	`integer`	ID of order item
`history[][pack][item][order]`	`object (Order)`	Order
`history[][pack][item][order][id]`	`integer`	Order ID
`history[][pack][item][offer]`	`object (Offer)`	SKU
`history[][pack][item][offer][externalId]`	`string`	SKU ID in store
`history[][pack][item][offer][xmlId]`	`string`	SKU ID in the warehouse system
`history[][pack][shipmentDate]`	`DateTime`	Pack shipment date
`history[][pack][invoiceNumber]`	`string`	Tax number
`history[][pack][deliveryNoteNumber]`	`string`	Packing list number
`history[][source]`	`string`	Source of change
`history[][user]`	`object (User)`
`history[][user][id]`	`integer`	User ID
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v3/orders/packs/{id} Getting information on pack

Getting information on pack

To access the method, the following permission is required order_read.

Parameters

Parameter	Type	Format	Description
`id`	`integer`		Pack ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pack`	`object (OrderProductPack)`	Pack - items pack, within the one item position, from one warehouse
`pack[id]`	`integer`	ID
`pack[purchasePrice]`	`float`	Purchasing price (in base currency)
`pack[quantity]`	`float`	Item quantity in pack
`pack[store]`	`string`	Warehouse
`pack[item]`	`object (OrderProduct)`	Order item
`pack[item][id]`	`integer`	ID of order item
`pack[item][order]`	`object (Order)`	Order
`pack[item][order][id]`	`integer`	Order ID
`pack[item][offer]`	`object (Offer)`	SKU
`pack[item][offer][externalId]`	`string`	SKU ID in store
`pack[item][offer][xmlId]`	`string`	SKU ID in the warehouse system
`pack[shipmentDate]`	`DateTime`	Pack shipment date
`pack[invoiceNumber]`	`string`	Tax number
`pack[deliveryNoteNumber]`	`string`	Packing list number

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Pack not found

POST /api/v3/orders/packs/{id}/delete Pack removing

Pack removing

To access the method, the following permission is required order_write.

Deleting the pack for the shipped order is not available.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The pack was successfully deleted
`400`	Error on pack removing

POST /api/v3/orders/packs/{id}/edit Pack editing

Pack editing

To access the method, the following permission is required order_write.

For the shipped order:

reduction in the quantity of products in the pack pack[quantity] is not available and increase in the quantity will lead to the automatic shipment
change of the pickup date of the pack pack[shipmentDate] is not available

Parameters

Parameter	Type	Description
`pack`	`object (SerializedOrderProductPack)`
`pack[purchasePrice]`	`float`	Purchasing price (in base currency)
`pack[quantity]`	`float`	Item quantity in pack
`pack[shipmentDate]`	`DateTime`	Pack shipment date
`pack[invoiceNumber]`	`string`	Tax number
`pack[deliveryNoteNumber]`	`string`	Packing list number

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Pack ID

HTTP statuses

Status code	Description
`200`	The pack was successfully changed
`400`	Error on pack editing

Data book

GET /api/v3/reference/countries Getting the list of available country codes

Getting the list of available country codes

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`countriesIso[]`	`array of strings`	List of ISO 3166-1 alpha-2 codes of active countries

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v3/reference/delivery-services Getting the list of delivery services

Getting the list of delivery services

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`deliveryServices[]`	`array of objects (DeliveryService)`	Delivery service
`deliveryServices[][name]`	`string`	Name
`deliveryServices[][code]`	`string`	Symbolic code

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/delivery-services/{code}/edit Delivery service creation/editing

Delivery service creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`deliveryService`	`object (SerializedDeliveryService)`
`deliveryService[code]`	`string`	`{not blank}`	Symbolic code
`deliveryService[name]`	`string`	`{not blank}`	Name
`deliveryService[deliveryType]`	`string`		Delivery type

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The delivery service was successfully changed
`201`	The new delivery service is successfully created
`400`	Error on query execution

GET /api/v3/reference/delivery-types Getting the list of delivery types

Getting the list of delivery types

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`deliveryTypes[]`	`array of objects (DeliveryType)`	Delivery type
`deliveryTypes[][paymentTypes]`	`array`	`deprecated` Allowed payment types. Use `deliveryPaymentTypes`
`deliveryTypes[][isDynamicCostCalculation]`	`boolean`	Dynamic type of calculation of delivery cost
`deliveryTypes[][isAutoCostCalculation]`	`boolean`	Delivery cost is calculated automatically by the delivery service
`deliveryTypes[][isAutoNetCostCalculation]`	`boolean`	Net cost of delivery is calculated automatically by the delivery service
`deliveryTypes[][isCostDependsOnRegionAndWeightAndSum]`	`boolean`	Delivery cost depends on the region, weight and order amount
`deliveryTypes[][isCostDependsOnDateTime]`	`boolean`	Delivery cost depends on the time and day of the week
`deliveryTypes[][currency]`	`string`	Currency
`deliveryTypes[][name]`	`string`	Name
`deliveryTypes[][code]`	`string`	Symbolic code
`deliveryTypes[][defaultCost]`	`double`	Default cost (in entity currency)
`deliveryTypes[][defaultNetCost]`	`double`	Default net cost (in entity currency)
`deliveryTypes[][description]`	`string`	Comment
`deliveryTypes[][deliveryPaymentTypes][]`	`array of objects (DeliveryTypePaymentType)`	Allowed payment types
`deliveryTypes[][deliveryPaymentTypes][][code]`	`string`	Symbolic code
`deliveryTypes[][deliveryPaymentTypes][][cod]`	`boolean`	Cash on delivery
`deliveryTypes[][integrationCode]`	`string`	Code of integration module
`deliveryTypes[][deliveryServices]`	`array`	Delivery services included in this delivery type
`deliveryTypes[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`deliveryTypes[][sites]`	`array`	Stores which the delivery type is available in for. The delivery type is available for all stores if array is empty

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/delivery-types/{code}/edit Delivery type creation/editing

Delivery type creation/editing

To access the method, the following permission is required reference_write.

For new delivery type it is necessary to specify the name name and symbolic code code. The symbolic code must be unique.

In the field integrationCode you may specify the code of that integrated delivery service, which was activated in the system. Otherwise there will be an error message.

Parameters

Parameter	Type	Format	Description
`deliveryType`	`object (SerializedDeliveryType)`
`deliveryType[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`deliveryType[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`deliveryType[defaultCost]`	`double`	`{not blank}{range: {>=0}}}`	Default cost (in entity currency)
`deliveryType[defaultNetCost]`	`double`	`{not blank}{range: {>=0}}}`	Default net cost (in entity currency)
`deliveryType[sites]`	`array`		Store codes array which the delivery type is available for
`deliveryType[integrationModule]`	`string`
`deliveryType[regionWeightCostConditions]`	`string`
`deliveryType[vatRate]`	`string`		VAT rate
`deliveryType[defaultTariffName]`	`string`		Name of a default tariff
`deliveryType[paymentTypes]`	`array`		`deprecated` Allowed payment types. Use `deliveryPaymentTypes`
`deliveryType[description]`	`string`		Comment
`deliveryType[defaultForCrm]`	`boolean`		Set by default for orders created in system
`deliveryType[integrationCode]`	`string`		Code of integration module
`deliveryType[deliveryServices]`	`array`		Delivery services included in this delivery type

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The delivery type was successfully changed
`201`	The new delivery type is successfully created
`400`	Error on query execution

GET /api/v3/reference/order-methods Getting the list of order methods

Getting the list of order methods

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`orderMethods[]`	`array of objects (OrderMethod)`	Order method
`orderMethods[][name]`	`string`	Name
`orderMethods[][code]`	`string`	Symbolic code
`orderMethods[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`orderMethods[][defaultForApi]`	`boolean`	Set by default for orders received through API

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/order-methods/{code}/edit Order method creation/editing

Order method creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`orderMethod`	`object (SerializedOrderMethod)`
`orderMethod[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`orderMethod[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`orderMethod[defaultForCrm]`	`boolean`		Set by default for orders created in system
`orderMethod[defaultForApi]`	`boolean`		Set by default for orders received through API

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The order method was successfully changed
`201`	The new order method is successfully created
`400`	Error on query execution

GET /api/v3/reference/order-types Getting the list of order types

Getting the list of order types

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`orderTypes[]`	`array of objects (OrderType)`	Order type
`orderTypes[][name]`	`string`	Name
`orderTypes[][code]`	`string`	Symbolic code
`orderTypes[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`orderTypes[][defaultForApi]`	`boolean`	Set by default for orders received through API
`orderTypes[][ordering]`	`integer`	Ordering

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/order-types/{code}/edit Order type creation/editing

Order type creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`orderType`	`object (SerializedOrderType)`
`orderType[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`orderType[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`orderType[ordering]`	`integer`	`{not blank}{range: {>=0}}}`	Ordering
`orderType[defaultForCrm]`	`boolean`		Set by default for orders created in system
`orderType[defaultForApi]`	`boolean`		Set by default for orders received through API

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The order type was successfully changed
`201`	The new order type is successfully created
`400`	Error on query execution

GET /api/v3/reference/payment-statuses Getting the list of payment statuses

Getting the list of payment statuses

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`paymentStatuses[]`	`array of objects (PaymentStatus)`	Payment status
`paymentStatuses[][name]`	`string`	Name
`paymentStatuses[][code]`	`string`	Symbolic code
`paymentStatuses[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`paymentStatuses[][defaultForApi]`	`boolean`	Set by default for orders received through API
`paymentStatuses[][paymentComplete]`	`boolean`	The sigh that order is paid
`paymentStatuses[][ordering]`	`integer`	Ordering
`paymentStatuses[][description]`	`string`	Comment
`paymentStatuses[][paymentTypes]`	`array`	Payment types, in which this payment status is used

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/payment-statuses/{code}/edit Payment status creation/editing

Payment status creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`paymentStatus`	`object (SerializedPaymentStatus)`
`paymentStatus[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`paymentStatus[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`paymentStatus[ordering]`	`integer`	`{not blank}{range: {>=0}}}`	Ordering
`paymentStatus[defaultForCrm]`	`boolean`		Set by default for orders created in system
`paymentStatus[defaultForApi]`	`boolean`		Set by default for orders received through API
`paymentStatus[paymentComplete]`	`boolean`		The sigh that order is paid
`paymentStatus[description]`	`string`		Comment

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The payment status was successfully changed
`201`	The new payment status is successfully created
`400`	Error on query execution

GET /api/v3/reference/payment-types Getting the list of payment types

Getting the list of payment types

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`paymentTypes[]`	`array of objects (PaymentType)`	Payment type
`paymentTypes[][name]`	`string`	Name
`paymentTypes[][code]`	`string`	Symbolic code
`paymentTypes[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`paymentTypes[][defaultForApi]`	`boolean`	Set by default for orders received through API
`paymentTypes[][description]`	`string`	Comment
`paymentTypes[][deliveryTypes]`	`array`	Compatible delivery types
`paymentTypes[][paymentStatuses]`	`array`	Array of identifiers of compatible payment statuses
`paymentTypes[][sites]`	`array`	Stores which the payment type is available in for. The payment type is available for all stores if array is empty

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/payment-types/{code}/edit Payment type creation/editing

Payment type creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`paymentType`	`object (SerializedPaymentType)`
`paymentType[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`paymentType[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`paymentType[sites]`	`array`		Store codes array which the payment type is available for
`paymentType[defaultForCrm]`	`boolean`		Set by default for orders created in system
`paymentType[defaultForApi]`	`boolean`		Set by default for orders received through API
`paymentType[description]`	`string`		Comment
`paymentType[paymentStatuses]`	`array`		Array of identifiers of compatible payment statuses

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The payment type was successfully changed
`201`	The new payment type is successfully created
`400`	Error on query execution

GET /api/v3/reference/product-statuses Getting the list of item statuses in order

Getting the list of item statuses in order

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`productStatuses[]`	`array of objects (OrderProductStatus)`	Item status in order
`productStatuses[][code]`	`string`	Symbolic code
`productStatuses[][ordering]`	`integer`	Ordering
`productStatuses[][createdAt]`	`DateTime`	Creation date
`productStatuses[][orderStatusByProductStatus]`	`string`	Order status, which is set, if all items has this status
`productStatuses[][orderStatusForProductStatus]`	`string`	Order status, in which the item status is changed to this
`productStatuses[][cancelStatus]`	`boolean`	Is cancellation status
`productStatuses[][name]`	`string`	Name

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/product-statuses/{code}/edit Item status creation/editing

Item status creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`productStatus`	`object (SerializedOrderProductStatus)`
`productStatus[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`productStatus[code]`	`string`		Symbolic code
`productStatus[type]`	`choice`	`[product-status-type-cancel]`	Payment type
`productStatus[ordering]`	`integer`		Ordering
`productStatus[cancelStatus]`	`boolean`		Is cancellation status
`productStatus[orderStatusByProductStatus]`	`string`		Order status, which is set, if all items has this status
`productStatus[orderStatusForProductStatus]`	`string`		Order status, in which the item status is changed to this

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The item status was successfully changed
`201`	The new item status is successfully created
`400`	Error on query execution

GET /api/v3/reference/sites Getting the stores list

Getting the stores list

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`sites[]`	`array of objects (Site)`	Store
`sites[][catalogId]`	`string`	Catalog ID
`sites[][isCatalogMainSite]`	`boolean`	Main store of catalog
`sites[][name]`	`string`	Name
`sites[][url]`	`string`	Store URL
`sites[][code]`	`string`	Store symbolic code
`sites[][description]`	`string`	Comment
`sites[][phones]`	`string`	Store phones
`sites[][address]`	`string`	Store address
`sites[][zip]`	`string`	Zip code
`sites[][defaultForCrm]`	`boolean`	Set by default for orders created in system
`sites[][ymlUrl]`	`string`	YML URL
`sites[][loadFromYml]`	`boolean`	Upload the catalog of this store from YML/ICML or not
`sites[][catalogUpdatedAt]`	`DateTime`	Date/time of the last successful YML/ICML uploading
`sites[][catalogLoadingAt]`	`DateTime`	Date/time of the last YML/ICML uploading
`sites[][contragent]`	`object (LegalEntity)`	Legal entity
`sites[][contragent][contragentType]`	`string`	Legal entity type
`sites[][contragent][legalName]`	`string`	Legal name
`sites[][contragent][legalAddress]`	`string`	Registration address
`sites[][contragent][INN]`	`string`	TIN
`sites[][contragent][OKPO]`	`string`	RNNBO
`sites[][contragent][KPP]`	`string`	IECC
`sites[][contragent][OGRN]`	`string`	PSRN
`sites[][contragent][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`sites[][contragent][certificateNumber]`	`string`	Certificate number
`sites[][contragent][certificateDate]`	`DateTime`	Certificate date
`sites[][contragent][BIK]`	`string`	RCBIC
`sites[][contragent][bank]`	`string`	Bank
`sites[][contragent][bankAddress]`	`string`	Bank address
`sites[][contragent][corrAccount]`	`string`	Corresponding account
`sites[][contragent][bankAccount]`	`string`	Settlement account
`sites[][contragent][code]`	`string`	Symbolic code
`sites[][contragent][countryIso]`	`string`	Country
`sites[][countryIso]`	`string`	Country ISO code

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/sites/{code}/edit Store creation/editing

Store creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`site`	`object (SerializedSite)`
`site[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`site[url]`	`string`	`{url}{length: {max: 255}}}`	Store URL
`site[code]`	`string`	`{length: {max: 255}}`	Store symbolic code
`site[description]`	`string`	`{length: {max: 3000}}`	Comment
`site[phones]`	`string`	`{length: {max: 255}}`	Store phones
`site[address]`	`string`	`{length: {max: 255}}`	Store address
`site[zip]`	`string`	`{length: {max: 255}}`	Zip code
`site[ymlUrl]`	`string`	`{length: {max: 1000}}`	YML URL
`site[defaultForCrm]`	`boolean`		Set by default for orders created in system
`site[loadFromYml]`	`boolean`		Upload the catalog of this store from YML/ICML or not
`site[countryIso]`	`string`		Country ISO code

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The store was successfully changed
`201`	The new store is successfully created
`400`	Error on query execution

GET /api/v3/reference/status-groups Getting the list of order status groups

Getting the list of order status groups

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`statusGroups[]`	`array of objects (StatusGroup)`	Status group
`statusGroups[][name]`	`string`	Name
`statusGroups[][code]`	`string`	Symbolic code
`statusGroups[][ordering]`	`integer`	Ordering
`statusGroups[][process]`	`boolean`	Is the order processing status or not
`statusGroups[][statuses]`	`array`	Orders statuses included in this group

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v3/reference/statuses Getting the list of order statuses

Getting the list of order statuses

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`statuses[]`	`array of objects (Status)`	Order status
`statuses[][name]`	`string`	Name
`statuses[][code]`	`string`	Symbolic code
`statuses[][ordering]`	`integer`	Ordering
`statuses[][group]`	`string`	Status group, which contains this status

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/statuses/{code}/edit Order status creation/editing

Order status creation/editing

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`status`	`object (SerializedStatus)`
`status[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`status[code]`	`string`	`{length: {max: 255}}`	Symbolic code
`status[ordering]`	`integer`	`{not blank}{range: {>=0}}}`	Ordering
`status[group]`	`string`	`{not blank}`	Status group, which contains this status

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The order status was successfully changed
`201`	The new order status is successfully created
`400`	Error on query execution

GET /api/v3/reference/stores Getting the list of warehouses

Getting the list of warehouses

To access the method, the following permission is required reference_read.

Response

Parameter	Type	Description
`stores[]`	`array of objects (Store)`	Warehouse
`stores[][externalId]`	`string`	External ID
`stores[][xmlId]`	`string`	1C identifier
`stores[][description]`	`string`	Warehouse description
`stores[][email]`	`string`	Warehouse email
`stores[][type]`	`string`	Warehouse type
`stores[][inventoryType]`	`string`	Type of warehouse stock
`stores[][address]`	`object (StoreAddress)`	Warehouse address
`stores[][address][index]`	`string`	Postal code
`stores[][address][countryIso]`	`string`	Country ISO code
`stores[][address][region]`	`string`	Region
`stores[][address][regionId]`	`integer`	Region ID in Geohelper
`stores[][address][city]`	`string`	City
`stores[][address][cityId]`	`integer`	City ID in Geohelper
`stores[][address][cityType]`	`string`	Locality type
`stores[][address][street]`	`string`	Street
`stores[][address][streetId]`	`integer`	Street ID in Geohelper
`stores[][address][streetType]`	`string`	Street type
`stores[][address][building]`	`string`	Building
`stores[][address][flat]`	`string`	Flat/office
`stores[][address][floor]`	`integer`	Floor
`stores[][address][block]`	`integer`	Entrance
`stores[][address][house]`	`string`	House
`stores[][address][housing]`	`string`	Housing
`stores[][address][metro]`	`string`	Underground
`stores[][address][notes]`	`string`	Notes to address
`stores[][address][text]`	`string`	Address as string
`stores[][phone]`	`object (StorePhone)`	Warehouse phone
`stores[][phone][number]`	`string`	Phone number
`stores[][contact]`	`string`	Contact person at the warehouse
`stores[][code]`	`string`	Symbolic code
`stores[][name]`	`string`	Name

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/reference/stores/{code}/edit Creation/editing of information on warehouse

Creation/editing of information on warehouse

To access the method, the following permission is required reference_write.

Parameters

Parameter	Type	Format	Description
`store`	`object (SerializedStore)`
`store[name]`	`string`	`{not blank}{length: {max: 255}}}`	Name
`store[email]`	`string`	`{length: {max: 255}}`	Warehouse email
`store[type]`	`string`	`[store-type-online\|store-type-retail\|store-type-supplier\|store-type-warehouse]`	Warehouse type
`store[inventoryType]`	`string`	`[available\|integer]`	Type of warehouse stock
`store[address]`	`object (StoreAddress)`		Warehouse address
`store[address][index]`	`string`		Postal code
`store[address][countryIso]`	`string`		Country ISO code
`store[address][region]`	`string`		Region
`store[address][regionId]`	`integer`		Region ID in Geohelper
`store[address][city]`	`string`		City
`store[address][cityId]`	`integer`		City ID in Geohelper
`store[address][cityType]`	`string`		Locality type
`store[address][street]`	`string`		Street
`store[address][streetId]`	`integer`		Street ID in Geohelper
`store[address][streetType]`	`string`		Street type
`store[address][building]`	`string`		Building
`store[address][flat]`	`string`		Flat/office
`store[address][floor]`	`integer`		Floor
`store[address][block]`	`integer`		Entrance
`store[address][house]`	`string`		House
`store[address][housing]`	`string`		Housing
`store[address][metro]`	`string`		Underground
`store[address][notes]`	`string`		Notes to address
`store[address][text]`	`string`		Address as string
`store[phone]`	`object (StorePhone)`		Warehouse phone
`store[phone][number]`	`string`		Phone number
`store[externalId]`	`string`		External ID
`store[xmlId]`	`string`		1C identifier
`store[description]`	`string`		Warehouse description
`store[code]`	`string`		Symbolic code

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The warehouse information was successfully changed
`201`	The new warehouse is successfully created
`400`	Error on query execution

Store

GET /api/v3/store/inventories Getting the leftover stocks and purchasing prices

Getting the leftover stocks and purchasing prices

To access the method, the following permission is required store_read.

The method allows to receive information about the stock balance and cost price of the SKUs. If the parameter filter[details]=1 is specified, the detailed elaboration of the stock balance and cost price will be returned. The data is returned by the stores, to which the used API key has the access, or by the certain store, if the parameter filter[site]=site-code is specified.

By default the information about both enabled and disabled products and SKUs is returned. To receive the information only about enabled products and SKUs, use the parameters filter[productActive]=1 and filter[offerActive]=1.

The field offers[][site] is returned only if the data is returned by the several stores.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100], [20\|50\|100\|250]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (InventoryAlternativeFilterData)`
`filter[ids][]`	`array of integers`		Array of SKU's ID
`filter[productExternalId]`	`string`	`{length: {max: 255}}`	Product external ID
`filter[productArticle][]`	`array of strings`		Array of product articles
`filter[offerExternalId][]`	`array of strings`		Array of external IDs for SKUs
`filter[offerXmlId][]`	`array of strings`		Array of XML IDs for SKUs
`filter[offerArticle][]`	`array of strings`		Array of articles for SKUs
`filter[sites][]`	`array of strings`		Stores
`filter[catalogs][]`	`array of integers`		Array of catalog's ID
`filter[productActive]`	`boolean`		Return the stock balance only for active products
`filter[offerActive]`	`boolean`		Return the stock balance only for active SKUs
`filter[details]`	`boolean`		Return the details for stock balance
`filter[site]`	`string`		Store
`filter[sort]`	`NULL`
`filter[direction]`	`string`

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`offers[]`	`array of objects (Offer)`	SKU
`offers[][externalId]`	`string`	SKU ID in store
`offers[][xmlId]`	`string`	SKU ID in the warehouse system
`offers[][site]`	`string`	`deprecated` Store. Use `getCatalog()`
`offers[][purchasePrice]`	`double`	SKU purchasing price (in base currency)
`offers[][quantity]`	`float`	Available quantity
`offers[][stores][]`	`array of objects (Inventory)`	Leftover stock by warehouses
`offers[][stores][][quantity]`	`float`	Quantity
`offers[][stores][][purchasePrice]`	`double`	Purchasing price (in base currency)
`offers[][stores][][store]`	`string`	Warehouse

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/store/inventories/upload Updating the leftover stocks and purchasing prices

Updating the leftover stocks and purchasing prices

To access the method, the following permission is required store_write.

The method allows to update the leftover stock and purchase prices by warehouses for SKUs. Per one query it is possible to update up to 250 SKUs. In one SKU it is possible to specify stocks up to 500 warehouses.

Field offers[][stores][][available] may be integer or fractional. Using actual stock accounting, 0 should be transmitted - in case of item absence at the warehouse, and 1 - in case of presence.

Each SKU should have at least one of three parameters: id, xmlId or externalId. If several or all above-mentioned parameters are specified, the search is made, first of all, by id, then by xmlId and then by externalId.

If the SKU relates to a service, the transmitted data will be ignored.

Parameters

Parameter	Type	Description
`offers[]`	`array of objects (SerializedOffer)`
`offers[][externalId]`	`string`	SKU ID in store
`offers[][xmlId]`	`string`	SKU ID in the warehouse system
`offers[][stores][]`	`array of objects (SerializedStore)`
`offers[][stores][][code]`	`string`	Symbolic code
`offers[][stores][][available]`	`float`	Quantity of available items or the fact of availability
`offers[][stores][][purchasePrice]`	`float`	Purchasing price
`site`	`string`	Symbolic code of store. Specified in case of SKUs identification by externalId

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`processedOffersCount`	`integer`	Quantity of successfully processed SKUs
`notFoundOffers[]`	`array of objects (Offer)`	SKU
`notFoundOffers[][externalId]`	`string`	SKU ID in store
`notFoundOffers[][xmlId]`	`string`	SKU ID in the warehouse system

HTTP statuses

Status code	Description
`200`	The stocks are uploaded
`400`	Error on leftover stocks uploading, or the current system settings don't allow to edit stocks

Telephony

POST /api/v3/telephony/call/event Call events

Call events

To access the method, the following permission is required telephony_write.

The method fix call events for the users with the additional codes code, from the phone phone. The field code contains JSON array.

The field type contains the event type: in - incoming call, out - outgoing call, hangup - call completion.

In case if type is equal to hangup, then in the field hangupStatus you can pass the status.

The field hangupStatus contains the call completion status: answered - call is received, no answered - there were no answer for the call, busy - the calling part gets the signal "busy", cancel - the call is cancelled, failed - failed to call. By default the value is answered.

Parameters

Parameter	Type	Format	Description
`phone`	`string`	`{length: {max: 255}}{not blank}}`	Phone
`type`	`string`	`{not blank}[hangup\|in\|out]}`	Event type
`hangupStatus`	`string`	`[answered\|busy\|cancel\|failed\|no answered]`	Status of call end
`code`	`string`	`{not blank}`	Manager extension code in telephony

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/telephony/calls/upload Calls uploading

Calls uploading

To access the method, the following permission is required telephony_write.

The method allows to save the call history. In one request you can pass up to 50 calls.

The field calls contains JSON.

The field calls[][date], contains date and time of the call in the format Y-m-d H:i:s.

The field calls[][type], may receive the following values: in - incoming call, out - outgoing call.

The field calls[][result], may receive the following values: failed - failed, answered - answered, busy - busy, no answer - no answer, not allowed - not allowed, unknown - unknown

The field calls[][externalId] contains the unique call identifier in the PABX, if there will be passed the value that is already exist the call will not be created.

The field calls[][recordUrl] contains the link to the call record, e.g. http://example.com/record.mp3. Supported records format is .wav, .mp3

Parameters

Parameter	Type	Format	Description
`calls[]`	`array of objects (Call)`		Call
`calls[][date]`	`DateTime`	`{not blank}`	Date/time of call
`calls[][type]`	`string`	`[in\|out], {not blank}`	Call type
`calls[][phone]`	`string`	`{not blank}{length: {max: 255}}}`	Phone number
`calls[][code]`	`string`	`{length: {max: 255}}`	Extension of user, who processed the call
`calls[][result]`	`string`	`[answered\|busy\|failed\|no answer\|not allowed\|unknown], {not blank}`	Call result
`calls[][duration]`	`integer`	`{range: {>=0, <=1000000000}}`	Call duration (in seconds)
`calls[][externalId]`	`string`	`{not blank}{length: {max: 255}}}`	Call ID in PBX
`calls[][recordUrl]`	`string`	`{length: {max: 2048}}`	Record url
`calls[][externalPhone]`	`string`	`{length: {max: 255}}`	External phone number

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`processedCallsCount`	`integer`	Quantity of successfully processed calls
`duplicateCalls`	`array`	Array of externalId, which are present in the system

HTTP statuses

Status code	Description
`200`	Calls are successfully uploaded
`400`	Error on query execution

GET /api/v3/telephony/manager Getting the responsible manager

Getting the responsible manager

To access the method, the following permission is required telephony_read.

The method returns responsible manager for the customer with the phone number phone, that is actually Online in the system and is in the status Free.

If there is no responsible manager, the field manager will be absent in the answer.

If the field ignoreStatus equals to 1, there will be the field manager in the response regardless of the status of the responsible manager in the system (Online status and/or Free status).

If the field details is equal to 1, there will be the following fields links, customer in the answer. Otherwise, the fields will be absent.

If the customer is found, the fields links[newCustomerLink], links[newOrderLink] will be absent in answer.

If the customer is not found, the fields customer, links[lastOrderLink], links[customerLink] will be absent in answer.

Parameters

Parameter	Type	Format	Description
`phone`	`string`	`{not blank}{length: {max: 255}}}`	Phone
`details`	`string`	`[0\|1]`	Detailed information
`ignoreStatus`	`string`	`[0\|1]`	Ignore the manager status

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`manager`	`object (SerializedManager)`	Manager
`manager[id]`	`string`	Manager Id
`manager[firstName]`	`string`	Manager's first name
`manager[lastName]`	`string`	Manager's last name
`manager[patronymic]`	`string`	Manager's patronymic
`manager[email]`	`string`	E-mail
`manager[code]`	`string`	Manager's extension code in telephony
`customer`	`object (SerializedCustomer)`	Customer
`customer[id]`	`string`	Customer ID
`customer[externalId]`	`string`	Id from external site
`customer[firstName]`	`string`	Customer's first name
`customer[lastName]`	`string`	Customer's last name
`customer[patronymic]`	`string`	Customer's patronymic
`customer[email]`	`string`	E-mail
`customer[phones][]`	`array of objects (CustomerPhone)`	Customer phone
`customer[phones][][number]`	`string`	Phone number
`links`	`object (SerializedLinks)`	Links
`links[newOrderLink]`	`string`	Link to the page of new order creation
`links[lastOrderLink]`	`string`	Link to the page of last order
`links[newCustomerLink]`	`string`	Link to the page of new customer creation
`links[customerLink]`	`string`	Link to the customer page

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v3/telephony/setting/{code} Telephony creation/editing

Telephony creation/editing

To access the method, the following permission is required telephony_read.

The method allows to create/enable/disable the telephony in the system and specify the necessary for work settings.

The field makeCallUrl contains the address to which the system will send a request to initiate a call. At attempt of calling there will be sent the GET request to the address makeCallUrl.

The field name contains the service name, that will be displayed in the system settings.

The field image contains the link to the service logo, that will be displayed in the system settings. By the specified address there should be the file in the formate svg.

Parameters

Parameter	Type	Description
`code`	`string`	Symbolic code
`clientId`	`string`	Client Id
`active`	`string`	Telephony activity
`makeCallUrl`	`string`	URL of the call initiation
`name`	`string`	Service name
`image`	`string`	Service logotype

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`201`	The telephony is created
`200`	The query was successfully executed
`400`	Error on query execution

CallbackGET {makeCallUrl} Initiation of call

Initiation of call

If in the telephony settings the field makeCallUrl is specified, when initiating of call, the GET request will be sent to the specified address. Expected return code is 200, otherwise user will receive error message.

Parameters

Parameter	Type	Format	Description
`code`	`string`	`{not blank}{length: {max: 255}}}`	Additional code
`phone`	`string`	`{not blank}{length: {max: 255}}}`	Phone
`clientId`	`string`	`{not blank}{length: {max: 255}}}`	Client id
`externalPhone`	`string`	`{length: {max: 255}}`	External phone number

HTTP statuses

Status code	Description
`200`	The query was successfully executed

CallbackGET {recordUrl} Listening of the call

Listening of the call

If the field recordUrl is specified for the call, when trying to listen the call, GET-request will be sent to the specified address. Expected return code is 200, otherwise user will receive the error message.

For correct playback of record must specify the correct header Content-Type

Parameters

Parameter	Type	Format	Description
`clientId`	`string`	`{not blank}{length: {max: 255}}}`	Client Id

HTTP statuses

Status code	Description
`200`	The query was successfully executed

Statistics

GET /api/v3/statistic/update Statistics updating

Statistics updating

To access the method, the following permission is required analytics_write.

Queues up the task to update key statistical indicators in the system. Retry timeout is 60 seconds. If calls are made more frequently, a 400 error will be returned.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed