diff --git a/adoc/bms_aaS/erp_api.adoc b/adoc/bms_aaS/erp_api.adoc index c6d28f1..1b92144 100644 --- a/adoc/bms_aaS/erp_api.adoc +++ b/adoc/bms_aaS/erp_api.adoc @@ -44,14 +44,16 @@ protocol_method:: POST method_name:: agent/parcel method_params:: new request_body:: {"order_id": "", "receiver": { "id": "", "phone": "", "email" : "", "first name" : "", "last_name": "", "patronymic": ""}, "delivery_type": "", "dest" : [, ], ["dest_address_id": ""], "dest_apartment": "", "weight" : , "price" : , "cod_amount" : , "type" : ":", "note" : "", "created_at": "", "contragent_id" : "", "sender": "", "dimensions": [, , ], "_comment" : "", "items": [, ...], "rolling_payments": } -expected_result:: 200 {"id" : "", "success": true} +expected_result:: 200 {"id" : "", "code": "", "success": true} + +NOTE: Если не указывать `order_id` в теле запроса, он будет сгенерирован системой. NOTE: Возможно указание параметра `dest` (координаты) *или* `dest_address_id` (ID адреса) NOTE: описание `PARCEL_ITEM_SPEC`: {"barcode": "", "sku": "", "name": "", "brand": "", "size": "", "quantity": , "weight": , "price": , "comment": "", "photos":[""], "color": "", "contragent_id": "", "non_returnable": } NOTE: Ключи: + -`cod_amount`, `contragent_id`, `sender`, `dimensions`, `_comment`, `items`, `rolling_payments` -- *опциональны.* + +`cod_amount`, `contragent_id`, `sender`, `dimensions`, `_comment`, `items`, `rolling_payments`,`order_id` -- *опциональны.* + `contragent_id` - необходимо указывать если в `type=COD`, так же в теле `item`, если `rolling_payments: true` NOTE: Для посылок с классификатором оплаты `COD` в качестве значения `cod_amount` будет подставляться параметр `price` в случае отсутствия явного его указания в параметрах. *`cod_amount` не может быть больше чем `price`*