2651
правка
Изменения
м
Нет описания правки
When writing the given documentation we assume that a person reading it has the level of expertise in coding sufficient for understanding the contents of this documentation, has a knowledge of XML and integration development environment. If you are not qualified as a developer you will have to hire a professional developer to implement your project.
If you still have questions after reading the given documentation, feel free to ask them via e-mail [mailto:support@courierexe.ru support@courierexe.ru]. In your e-mail email message , please introduce yourself, leave your contact information (your phone number, Skype login) and the name of the company that you want to integrate with.
== CMS Integrations ==
Use the following credentials:
* Extra client code. This is a digital code, company`s unique identifier. Request this parameter from the courier service you are integrating with. You can see this code in MeaSoft desktop interface by using its main menu '''Reference''' > '''Additional OptionsModules'''. Extra code is given in the second hyperlink (it is marked with an asterisk on the screenshot below): [[File:extra1.png|750px|none]]
* Login. It is a user name for client account and API. Courier service creates login in the client card on the '''Other''' tab in the '''User name''' field. You will probably have to create a new client card (shown on the screenshot below) in MeaSoft software.
* Password. It is a password for client account and API. Courier service creates password in the client card on the '''Other''' tab in the '''Password''' field. (shown on the screenshot below).
:* '''''price''''' — purchase amount within the limit.
* '''advprices''' — a container describing additional value-added services. It is an optional container. It has the following attributes: <span style="color: red;>To use it in the API, in the [[Courier Service Account#Setting Up Client Account|client account settings]], enable the '''Additional Value-added services''' field for new order and pickup request.</span>
:* '''''code''''' — service code.
:* '''''value''''' — service value. If service type is Boolean, set the value to '''True'''.
If you want to apply additional value-added services (for example, delivery, cross-docking, lifting upstairs, etc.), specify them in the same '''items''' container as items without a SKU ID.
*'''costcode''' — employee cost code.
:* '''''delivery''''' — one-way trip cost.
:* '''''return''''' — return trip cost (if '''order''' > '''return=YES''').
The '''deliveryprice''' tag includes additional value-added services. The option is available for the Premium and Maximum courier service account plans::* '''''advprice''''' — additional value-added service name.:* '''''code''''' — additional value-added service code.:* '''''price''''' — additional value-added service amount.
* '''status''' — delivery status. See the list of statuses below. It has the following attributes:
</source>
== Additional Value-Added Services List ==
'''Request Example'''
'''advprices''' — root container. Required.
*'''visible''' — indicates whether only the additional value-added services available in client account are returned. Optional. Possible values: '''Yes''', '''No'''. The default value is '''No'''.
Параметры:
*'''code''' — internal service code.
*'''name''' — service name. If in the '''Additional Value-Added Services''' list the '''Name in client account''' column is not empty, the column value is returned.<!--*'''hine''' — additional value-added service hint for user.-->
*'''type''' — service type. Possible values:
:*'''bool''' — for services with the '''Check box''' input type.
