Изменения

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

API Documentation

828 байт убрано, 12:50, 2 июля 2021
м
Response Fields
:* '''''delivery''''' — one-way trip cost.
:* '''''return''''' — return trip cost (if '''order''' > '''return=YES''').
* The '''statusdeliveryprice''' is a delivery status (see the list of statuses below). It has the following attributes (they are filled in starting from version 2008.0.0tag includes additional services.670 of Option available for the system)Premium and Maximum courier service account plans::* '''''eventstoreadvprice''''' is a branch which the following status is related to— additional service name.:* '''''eventtimecode''''' is the time of status change (time of status change depends on the location of a branch)— additional service code.:* '''''createtimegmtprice''''' is the time of the actual status change (GMT):* '''''message''''' is the name of a receiving branch in case of a transfer between branches:* '''''title''''' is the name of a status in Russian — additional service amount.
* '''statushistorystatus''' is — delivery status. See the history list of delivery statusesbelow. It contains has the list of following attributes::* '''''eventstore''status''' containers. It is filled in only for Premium and Maximum plan starting from version 2008.0.0.670 of — courier service branch which set the systemcurrent status. :* '''customstatecode''eventtime''''' is an internal — time of latest status code of a delivery service. Please, check with the delivery service for its values. They are assigned by the delivery service change as in “Guides” - “Statuses” - “15 Correspondence statuses” section. The guide is not transferred to the client via API due to a possible presence of delivery service technological statuses in itcurrent branch timezone. :* '''clientstatecode''' is a customer`s status code. It is used in case a customer is transferring his codes of delivery/reasons for non-delivery statuses. * 'createtimegmt''deliveredto''' is — status change entry created in the information on delivery or a reason for non-deliverydatatbase, GMT. Used to arrange the entries in chronological order.:* '''delivereddate''message' is the date of delivery. * '''deliveredtime''' is the time — name of deliverya recipient branch. It can be left empty Used in case of non-deliveryorder transfer between branches. :* '''outstrbarcode''title' is a contractor`s code ('''' — name of the order code within an external system). It is used status in integrations with external systemsRussian.
* '''statushistory''' — history of delivery statuses. It contains the list of '''status''' containers. It is filled in only for Premium and Maximum plans. * '''customstatecode''' — internal status code of a courier service. Please, check with the courier service for its values. They are assigned by the courier service in '''References''' > '''Statuses''' > '''15 Shipment statuses'''. The reference is not transferred to the client via API due to possible presence of delivery service internal statuses in it.* '''clientstatecode''' — client status code. It is used if client submits their own codes of delivery statuses and reasons for non-delivery. * '''deliveredto''' — actual information on delivery or a reason for non-delivery.* '''delivereddate''' — actual delivery date.* '''deliveredtime''' — actual delivery date. It can be empty in case of non-delivery.* '''arrival''' — scheduled delivery date formatted as YYYY-MM-DD HH:MM:SS.* '''outstrbarcode''' — service partner system code (in an external system). It is used for integration with external systems.* '''return_message''' — return information.* '''department''' — the order creator's department. The '''status''' container can have the following values:
: AWAITING_SYNC — Awaiting for sync. Order is not in the courier company database yet.
: '''NEW''' — Created successfully, transfered submitted to the courier company.: NEWPICKUP — The pickup task is Pickup created.: PICKUP — The order is picked Picked up from the sender.: WMSASSEMBLED — The order Order is assembled picked at the fulfillment warehousecenter.: WMSDISASSEMBLED — The order Order is disassembled to unpicked at the fulfillment warehousecenter.: '''ACCEPTED''' — Received by the warehouse.: CUSTOMSPROCESS — Customs control pendingclearance.: CUSTOMSFINISHED — Customs control passedclearance complete.: CONFIRM — Dispatch Delivery is confirmedscheduled.: UNCONFIRM — Dispatch has not been confirmedFailed to arrange for delivery time.: DEPARTURING — Dispatch from one warehouse to another is pendingWarehouse transfer planned.: DEPARTURE — Dispatched from one warehouse to anotherWarehouse transfer shipped.: INVENTORY — Inventory. Made sure the order shipment is in the warehouse.: PICKUPREADY — Ready Available for pick up pickup at the pickup point of issue.: '''DELIVERY''' — Given to the courier to be deliveredOut for delivery.: COURIERCANCELED COURIERDELIVERED Not delivered Delivered (to be confirmed, the COURIERRETURN state as reported by courier). Confirmation by manager is expected)to change status to COMPLETE.: COURIERDELIVERED COURIERPARTIALLY Delivered Partially delivered (to be confirmed, the COMPLETE state as reported by courier). Confirmation by manager is expected)to change status to PARTIALLY.: COURIERPARTIALLY COURIERCANCELED Partially delivered Refused (to be confirmed, the PARTIALLY state as reported by courier). Confirmation by manager is expected)to change status to COURIERRETURN.: COURIERRETURN — Returned to warehouse by the courier. The courier couldn`t failed to deliver the order to the receiver recepient and returned it back to the warehouse. This is an intermediate status after which , the manager is checking to check whether the order is to be delivered again (the DATECHANGE/DELIVERY states) or this is a final non-delivery (CANCELED).: DATECHANGE — PostponementRescheduled
: '''COMPLETE''' — Delivered.
: '''PARTIALLY''' — Partially delivered.
: '''CANCELED''' — Not delivered (ReturnReturned/CancellationCanceled). After this state the The order must be returned tho the to sender, and will have the RETURNING and RETURNED states.
: RETURNING — Return to the sender is planned (after CANCELED).: RETURNED — Returned to the sender.
: LOST — Lost.
<!--
: NEW - New
: ACCEPTED - Received by the warehouse
: INVENTORY - Inventory
: DEPARTURING - Dispatch is planned
: DEPARTURE - Dispatched from the warehouse
: DELIVERY - Given to the courier to be delivered
: COURIERDELIVERED - Delivered (to be confirmed)
: COMPLETE - Delivered
: PARTIALLY - Partially delivered
: COURIERRETURN - Returned by the courier. The courier couldn`t deliver the order to the receiver and returned it back to the warehouse. This is an intermediate status after which the manager is checking whether the courier has to make another attempt to deliver the order or this is a final non-delivery.
: CANCELED - Not delivered (Return/Cancellation)
: RETURNING - Return is planned
: RETURNED - Returned
: CONFIRM - Dispatch is confirmed
: DATECHANGE - Postponement
: NEWPICKUP - Pickup is created
: UNCONFIRM - Dispatch has not been confirmed
: PICKUPREADY - Ready for pickup
-->
''Note:'' The set of currently used statuses may be expanded and changed in the future. 
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
 # '''Please, note!statushistory''' # and '''statushistorydeliveryprice''' is are filled in for tariff "[[Member_area Courier Service Account#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5Personal Account Functions|Premium and Maximum]]"courier service account plans only.# The system can never guarantee the order going through a set sequence of statuses successively, i. eis not fixed.For example, you can get "the COMPLETE" status after your first query and "then NEW" status after your second query - such things can happen in case when, for example, the because an operator has mistakenly marked an the order as a completed one by mistake and then corrected his mistakeit.
</div>
<br />
=== Newly changed statuses transfer ===

Навигация