Поиск по сайту

API
Главная / API - Changing the dispatch address/time

Changing the dispatch address/time

Обновлено 11.06.2021
131 кб

General information 

The service allows changing the dispatch address and time in case shipping from the address has been ordered as well as changing the dispatch from the address to the dispatch from the terminal. To check the possibility of changing the dispatch address and time, use Checking possibility to change the order method.

Changing the dispatch address and time

Method request

Request example

Method address: https://api.dellin.ru/v3/orders/change_pickup.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"00000000",
   "variant":"address",
   "terminalID":23,
   "addressID":457824578,
   "address":{
      "street":"7800000000004380000000000",
      "search":"Санкт-Петербург, ул. Ленина, 1",
      "house":"4",
      "building":"3",
      "structure":"лит. А",
      "flat":"214а"
   },
   "produce_date":"2020-10-01",
   "time":{
      "worktimeStart":"09:00",
      "worktimeEnd":"18:00",
      "breakStart":"12:30",
      "breakEnd":"13:30",
      "exactTime":true
   },
   "contactIDs":[
      12345678,
      78456123
   ],
   "contactPersons":[
      {
         "name":"Иван Иванович"
      },
      {
         "name":"Петр Петрович"
      }
   ],
   "phoneIDs":[
      98765412,
      65478921
   ],
   "phoneNumbers":[
      {
         "number":"79213332211",
         "ext":"0123"
      }
   ]
}

}

Method address: https://api.dellin.ru/v3/orders/change_pickup.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>00000000</orderID>
   <variant>address</variant>
   <terminalID>23</terminalID>
   <addressID>457824578</addressID>
   <address>
      <street>7800000000004380000000000</street>
      <search>Санкт-Петербург, ул. Ленина, 1</search>
      <house>4</house>
      <building>3</building>
      <structure>лит. А</structure>
      <flat>214а</flat>
   </address>
   <produce_date>2020-10-01</produce_date>
   <time>
      <worktimeStart>09:00</worktimeStart>
      <worktimeEnd>18:00</worktimeEnd>
      <breakStart>12:30</breakStart>
      <breakEnd>13:30</breakEnd>
      <exactTime>true</exactTime>
   </time>
   <contactIDs>12345678</contactIDs>
   <contactIDs>78456123</contactIDs>
   <contactPersons>
      <name>Иван Иванович</name>
   </contactPersons>
   <contactPersons>
      <name>Петр Петрович</name>
   </contactPersons>
   <phoneIDs>98765412</phoneIDs>
   <phoneIDs>65478921</phoneIDs>
   <phoneNumbers>
      <number>79213332211</number>
      <ext>0123</ext>
   </phoneNumbers>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription

appkey

YesstringApplication key. To get the key, register
sessionIDYesstringSession ID. To get the session ID, use "User authorization" service

orderID

YesstringThe number of the order for which it is necessary to change the dispatch address and time
variantYesstring

Shipping method.

Available values:

  • "terminal" - shipping from the terminal;
  • "address" - shipping from the address
terminalIDNo*integer

Terminal ID from the "Terminals directory

One of the excluding parameters is required: "terminalID", "addressID", "address"
addressIDNo*integer

Address ID from the "Address book"

One of the excluding parameters is required: "terminalID", "addressID", "address"
addressNo*object

Address. The new address must be in the same region as the one originally specified

One of the excluding parameters is required: "terminalID", "addressID", "address"

address.search 

No*string

Address as a string. Minimum 2 symbols, maximum 1024. Along with the address it is necessary to pass the name of the city

Address information must be passed in the request therefore either "search" parameter is required or "street" and "house" parameters are required.
address.streetNo*string

CLADR* code of the street (see. "CLADR search").

*CLADR - Classifier of Addresses of Russian Federation 

Address information must be passed in the request therefore either "search" parameter is required or "street" and "house" parameters are required.
address.houseNo*string

House number, including the letter. For example, "13/A".

Maximum 7 characters

Address information must be passed in the request therefore either "search" parameter is required or "street" and "house" parameters are required.
address.buildingNostring

Building.

Maximum 5 characters

If "search" parameter is passed in the request, then "street", "house" or "building" parameters must not be passed in the request
address.structureNostring

Structure.

Maximum 7 characters

If "search" parameter is passed in the request, then "street", "house" or "building" parameters must not be passed in the request
address.flatNostring

Apartment/office, including the letter. For example, "222 A".

Maximum 5 characters

If "search" parameter is passed in the request, then "street", "house" or "building" parameters must not be passed in the request
produce_dateNo*string

Date of cargo transfer to the terminal of departure or date of forwarding driver arrival to the sender.

Format: YYYY-MM-DD

*If "variant" parameter value is "address", then parameter is required
timeNo*object

Time of cargo hand over at the address.

*If "variant" parameter value is "address", then parameter is required
time.worktimeStartYesstring

Period start.

Format: HH:MM

time.worktimeEndYesstring

Period end.

Format: HH:MM

time.breakStartNostring

Break start.

Format: HH:MM

time.breakEndNostring

Break start.

Format: HH:MM

time.exactTimeNoboolean

Flag indicating that delivery at the exact time is required.

Default value: "false"

contactIDs

No*array of integers

Contact persons IDs from "Address book".

Maximum 3 elements in the array.

*One of the two excluding parameters - "contactIDs" or"contactPersons" - is required

contactPersons

No*array of contactPersons

Contact persons data.

Maximum 3 elements in the array.

*One of the two excluding parameters - "contactIDs" or"contactPersons" - is required

contactPersons.name

YesstringContact person name

phoneIDs

No*array of integers

Phone number IDs from "Address book".

Maximum 3 elements in the array

*One of the two excluding parameters - "phoneIDs" or"phoneNumbers" - is required

phoneNumbers

No*array of phoneNumbers

Phone numbers list.

Maximum 3 elements in the array

*One of the two excluding parameters - "phoneIDs" or"phoneNumbers" - is required

phoneNumbers.number

YesstringPhone number. 15 characters maximum (the only valid non-digit sign is the plus sign at the beginning of the string)

phoneNumbers.ext

NostringExtension phone number. 5 digits maximum

Method response

Response example

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-18 12:52:26"
   },
   "data":{
      "state":"success",
      "information": "Смена адреса и времени отправки груза будет бесплатной при подаче запроса до 17:00 (по местному времени) дня, предшествующего дню отправки.",
      "foundAddresses": [
            {
                "source": "Санкт-Петербург, ул. Ленина, 1",
                "result": "Россия, г Санкт-Петербург, г Санкт-Петербург, ул Ленина, д 1",
                "field": "address"
            }
        ]
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-18 12:52:26</generated_at>
   </metadata>
   <data>
      <state>success</state>
      <information>Смена адреса и времени отправки груза будет бесплатной при подаче запроса до 17:00 (по местному времени) дня, предшествующего дню отправки.</information>
      <foundAddresses>
         <source>Санкт-Петербург, ул. Ленина, 1</source>
         <result>Россия, г Санкт-Петербург, г Санкт-Петербург, ул Ленина, д 1</result>
         <field>address</field>
      </foundAddresses>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusinteger

Emulated status http-code. If successful, code 200 is returned. In case of error - 400

metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataobjectSuccess confirmation
data.statestring

Status in English. Possible value - "success"

data.informationstringInformation on conditions when the dispatch address and time can be changed free of charge
data.foundAddressesarray of FoundAddressesData on found addresses. The parameter is present in the response if "address.search" parameter was passed in the request

FoundAddresses
FoundAddresses
ParameterTypeDescription
fieldstringThe parent object that was used to pass the "search" parameter
sourcestring

Entered value

resultstring

Address found

Error handling

Except for common API errors the method response may contain the following errors:

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation

621001

400По данному заказу изменение адреса и времени недоступноThe dispatch address and time for the order can not be changed--

621002

400По данному заказу изменение адреса и времени недоступноThe dispatch address and time for the order can not be changedИзменение по данному заказу недоступно в связи с отсутствием доступаIt is not possible to change the order details since there is no access