Изменения

Перейти к: навигация, поиск

API Documentation

12 байт добавлено, 10:08, 2 августа 2021
м
Нет описания правки
'''Fields Description'''
*'''neworder''' is a root container, required. :*'''''newfolder''''' is an attribute of a new order, possible values: '''YES''', '''NO'''. If '''YES''', a new order is created for the specified shipment in the courier service system. It is an optional element.
*'''order''' is a container used for description of one order, required. A single '''neworder''' container can have a number of '''order''' containers to create several orders by using one query.:*'''''orderno''''' is an order number. It should be entered here Specify it if it is assigned by the client. In case it is not assigned, this field can be left empty. The system will generate its own number and send it back in the response. The system checks whether the specified number has been used within the current calendar year. If it already exists in the system, the order is not created, error 17 "Such number exists" returns.
*'''barcode''' is an order barcode. In case the customer uses barcodes for his dispatches and the barcode is different from the order number, the barcode is entered into this field. In case there are several packages and they are individually marked, underscore character can be used as a mask to indicate barcoded item number varying for different packages within one order.
''For example'': There are 20 items in order No. 123 packed in 3 packages. The client generates 3 barcodes for each package: CLNT0012301, CLNT0012302, CLNT0012303, where CLNT is a client prefix, 00123 is an order number, 01-03 is the number for each package in the order. In this case CLNT00123__ should be entered into the '''barcode''' field. Thus, MeaSoft knows the last 2 characters can be any values and will display barcodes for the same order. If it is not you who will print packing slips with the specified barcode, the barcode must not exceed 25 characters, otherwise it cannot be fully seen on the standard printing forms.
*'''sender''' presents the information about order sender. It is an optional container.
<source lang="xml">
<sender>
=== Response Fields ===
All responce response fields correspond to the [[#Example of New Order|order creating request]] structure, with the following additions:
* The '''order''' container attributes:
=== Edit Response Fields ===
All response fields correspond to the [[#Creating Order|order creating responce response structure]], except for:
*the <code>editorder</code> tag is returned instead of <code>neworder</code>.
* '''auth''' — authorization. Required.
* '''order''' — container of the order being canceled. Required. The request can contain more than one '''order'''. It has the following attributes:
:* '''''orderno''''' — external order code.
:* '''''ordercode''''' — internal order code.
Either '''''orderno''''' or '''''ordercode''''' is required.
*'''auth''' — is authorization. Required.
*'''orders''' — list of orders to get print forms for. It contains tags '''order''' with the following attributes:
** '''''orderno''''' — external order code.
** '''''ordercode''''' — internal order code.
*: Specify either of the attributes for all the orders. The '''''ordercode''''' attribute is recommended.
*'''reserved''' — quantity of goods reserved. It may outnumber the stock balance if customers are waiting for the next delivery. ''This field may be unavailable in some setups.''
== Goods Item Movement ==
'''Request Example'''
:* '''number''' — order number.
:* '''date''' — order date.
:* '''orderno''' — external order code.
:* '''barcode''' — barcode.
:* '''company''' — company.
*'''code''' — record code.
*'''ordercode''' — external order code.
*'''orderno''' — order cipher.
*'''orderdate''' — order date.

Навигация